Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added useRawValueOnCopy prop #723

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fresh-pans-cough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-mentions": minor
---

Added useRawValueOnCopy prop
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ The `MentionsInput` supports the following props for configuring the widget:
| forceSuggestionsAboveCursor | boolean | false | Forces the SuggestionList to be rendered above the cursor |
| a11ySuggestionsListLabel | string | `''` | This label would be exposed to screen readers when suggestion popup appears |
| customSuggestionsContainer | function(children) | empty function | Allows customizing the container of the suggestions |
| useRawValueOnCopy | boolean | false | Returns the raw value (with tags) when copying the content |

Each data source is configured using a `Mention` component, which has the following props:

Expand Down
12 changes: 7 additions & 5 deletions src/MentionsInput.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ const propTypes = {
forceSuggestionsAboveCursor: PropTypes.bool,
ignoreAccents: PropTypes.bool,
a11ySuggestionsListLabel: PropTypes.string,
useRawValueOnCopy: PropTypes.bool,

value: PropTypes.string,
onKeyDown: PropTypes.func,
Expand Down Expand Up @@ -110,6 +111,7 @@ class MentionsInput extends React.Component {
ignoreAccents: false,
singleLine: false,
allowSuggestionsAboveCursor: false,
useRawValueOnCopy: false,
onKeyDown: () => null,
onSelect: () => null,
onBlur: () => null,
Expand Down Expand Up @@ -428,14 +430,14 @@ class MentionsInput extends React.Component {
)
const markupEndIndex = mapPlainTextIndex(value, config, selectionEnd, 'END')

const textValue = event.target.value.slice(selectionStart, selectionEnd)
const rawValue = value.slice(markupStartIndex, markupEndIndex)

event.clipboardData.setData(
'text/plain',
event.target.value.slice(selectionStart, selectionEnd)
)
event.clipboardData.setData(
'text/react-mentions',
value.slice(markupStartIndex, markupEndIndex)
this.props.useRawValueOnCopy ? rawValue : textValue
)
event.clipboardData.setData('text/react-mentions', rawValue)
}

supportsClipboardActions(event) {
Expand Down
50 changes: 50 additions & 0 deletions src/MentionsInput.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -476,4 +476,54 @@ describe('MentionsInput', () => {
expect(preventDefault).not.toHaveBeenCalled()
})
})

describe('when using the useRawValueOnCopy', () => {
const plainTextValue = "Hi First, \n\nlet's add Second to the conversation."
const value =
"Hi @[First](first), \n\nlet's add @[Second](second) to the conversation."

it.each(['cut', 'copy'])(
'should copy the raw value to the clipboard.',
(eventType) => {
const component = mount(
<MentionsInput value={value} useRawValueOnCopy>
<Mention trigger="@[__display__](__id__)" data={data} />
</MentionsInput>,
{
attachTo: host,
}
)

const textarea = component.find('textarea')

const selectionStart = plainTextValue.indexOf('First') + 2
const selectionEnd = plainTextValue.length

textarea.simulate('select', {
target: { selectionStart, selectionEnd },
})
textarea.getDOMNode().setSelectionRange(selectionStart, selectionEnd)

const setData = jest.fn()

const event = new Event(eventType, { bubbles: true })
event.clipboardData = { setData }

textarea.getDOMNode().dispatchEvent(event)

expect(setData).toHaveBeenCalledTimes(2)

expect(setData).toHaveBeenNthCalledWith(
1,
'text/plain',
"@[First](first), \n\nlet's add @[Second](second) to the conversation."
)
expect(setData).toHaveBeenNthCalledWith(
2,
'text/react-mentions',
"@[First](first), \n\nlet's add @[Second](second) to the conversation."
)
}
)
});
})