Skip to content

Commit

Permalink
feat: Support placeholder for inline search input (#404)
Browse files Browse the repository at this point in the history
Co-authored-by: Hrusikesh Panda <[email protected]>
  • Loading branch information
ldeveber and mrchief authored Sep 28, 2020
1 parent 0b8d9b7 commit dd2dbbc
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 7 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,11 @@ The `texts` object requires the following structure:

```js
{
placeholder, // optional: The text to display as placeholder on the search box. Defaults to `Choose...`
noMatches, // optional: The text to display when the search does not find results in the content list. Defaults to `No matches found`
label, // optional: Adds `aria-labelledby` to search input when input starts with `#`, adds `aria-label` to search input when label has value (not containing '#')
labelRemove, // optional: The text to display for `aria-label` on tag delete buttons which is combined with `aria-labelledby` pointing to the node label. Defaults to `Remove`
placeholder, // optional: The text to display as placeholder on the search box. Defaults to `Choose...`
inlineSearchPlaceholder, // optional: The text to display as placeholder on the inline search box. Only applicable with the `inlineSearchInput` setting. Defaults to `Search...`
noMatches, // optional: The text to display when the search does not find results in the content list. Defaults to `No matches found`
label, // optional: Adds `aria-labelledby` to search input when input starts with `#`, adds `aria-label` to search input when label has value (not containing '#')
labelRemove, // optional: The text to display for `aria-label` on tag delete buttons which is combined with `aria-labelledby` pointing to the node label. Defaults to `Remove`
}
```

Expand Down Expand Up @@ -592,6 +593,7 @@ Released 2017 by [Hrusikesh Panda](https://github.com/mrchief) @ [Dow Jones](htt
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore -->
| [<img src="https://avatars0.githubusercontent.com/u/966550?v=4" width="100px;" alt="toofff"/><br /><sub><b>toofff</b></sub>](http://www.yanoucrea.fr)<br />[🐛](https://github.com/dowjones/react-dropdown-tree-select/issues?q=author%3Atoofff "Bug reports") [💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=toofff "Code") [📖](https://github.com/dowjones/react-dropdown-tree-select/commits?author=toofff "Documentation") [🤔](#ideas-toofff "Ideas, Planning, & Feedback") | [<img src="https://avatars3.githubusercontent.com/u/1257968?v=4" width="100px;" alt="Grégory Copin"/><br /><sub><b>Grégory Copin</b></sub>](http://www.les-tilleuls.coop)<br />[🐛](https://github.com/dowjones/react-dropdown-tree-select/issues?q=author%3AGregcop1 "Bug reports") [💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=Gregcop1 "Code") | [<img src="https://avatars1.githubusercontent.com/u/7589718?v=4" width="100px;" alt="PRIYANSHU AGRAWAL"/><br /><sub><b>PRIYANSHU AGRAWAL</b></sub>](https://github.com/priyanshu92)<br />[🐛](https://github.com/dowjones/react-dropdown-tree-select/issues?q=author%3Apriyanshu92 "Bug reports") [💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=priyanshu92 "Code") [🤔](#ideas-priyanshu92 "Ideas, Planning, & Feedback") | [<img src="https://avatars3.githubusercontent.com/u/425261?v=4" width="100px;" alt="James Greenaway"/><br /><sub><b>James Greenaway</b></sub>](http://james.greenaway.io)<br />[🐛](https://github.com/dowjones/react-dropdown-tree-select/issues?q=author%3Ajvgreenaway "Bug reports") [💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=jvgreenaway "Code") [🤔](#ideas-jvgreenaway "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/36223986?v=4" width="100px;" alt="itrombitas"/><br /><sub><b>itrombitas</b></sub>](https://github.com/itrombitas)<br />[💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=itrombitas "Code") | [<img src="https://avatars2.githubusercontent.com/u/18341459?v=4" width="100px;" alt="Dave Henton"/><br /><sub><b>Dave Henton</b></sub>](https://github.com/davehenton)<br />[🚇](#infra-davehenton "Infrastructure (Hosting, Build-Tools, etc)") | [<img src="https://avatars3.githubusercontent.com/u/4869717?v=4" width="100px;" alt="Swetha Kolli"/><br /><sub><b>Swetha Kolli</b></sub>](https://github.com/nagaskolli)<br />[💻](https://github.com/dowjones/react-dropdown-tree-select/commits?author=nagaskolli "Code") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
Expand Down
6 changes: 6 additions & 0 deletions __snapshots__/src/index.test.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Generated by [AVA](https://ava.li).
>
<Input
clientId="rdts"
inlineSearchInput={false}
inputRef={Function inputRef {}}
onBlur={Function {}}
onFocus={Function {}}
Expand Down Expand Up @@ -203,6 +204,7 @@ Generated by [AVA](https://ava.li).
>
<Input
clientId="rdts"
inlineSearchInput={true}
inputRef={Function inputRef {}}
onBlur={Function {}}
onFocus={Function {}}
Expand Down Expand Up @@ -370,6 +372,7 @@ Generated by [AVA](https://ava.li).
<Input
clientId="rdts"
disabled={true}
inlineSearchInput={false}
inputRef={Function inputRef {}}
onBlur={Function {}}
onFocus={Function {}}
Expand Down Expand Up @@ -506,6 +509,7 @@ Generated by [AVA](https://ava.li).
>
<Input
clientId="rdts"
inlineSearchInput={false}
inputRef={Function inputRef {}}
mode="radioSelect"
onBlur={Function {}}
Expand Down Expand Up @@ -655,6 +659,7 @@ Generated by [AVA](https://ava.li).
>
<Input
clientId="rdts"
inlineSearchInput={false}
inputRef={Function inputRef {}}
onBlur={Function {}}
onFocus={Function {}}
Expand Down Expand Up @@ -708,6 +713,7 @@ Generated by [AVA](https://ava.li).
>
<Input
clientId="rdts"
inlineSearchInput={false}
inputRef={Function inputRef {}}
onBlur={Function {}}
onFocus={Function {}}
Expand Down
Binary file modified __snapshots__/src/index.test.js.snap
Binary file not shown.
11 changes: 11 additions & 0 deletions __snapshots__/src/input/index.test.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ The actual snapshot is saved in `index.test.js.snap`.

Generated by [AVA](https://ava.li).

## renders inline search placeholder

> Snapshot 1
<input
className="search"
onChange={Function {}}
placeholder="Search something"
type="text"
/>

## renders input

> Snapshot 1
Expand Down
Binary file modified __snapshots__/src/input/index.test.js.snap
Binary file not shown.
24 changes: 23 additions & 1 deletion docs/src/stories/Options/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ class WithOptions extends PureComponent {
disabled: false,
readOnly: false,
hierarchical: false,
placeholder: 'Choose...',
inlineSearchPlaceholder: 'Search...',
}
}

Expand Down Expand Up @@ -48,6 +50,8 @@ class WithOptions extends PureComponent {
readOnly,
showDropdown,
inlineSearchInput,
placeholder,
inlineSearchPlaceholder,
} = this.state

return (
Expand Down Expand Up @@ -83,6 +87,24 @@ class WithOptions extends PureComponent {
<option value="always">Always</option>
</select>
</div>
<div style={{ marginBottom: '10px' }}>
<label htmlFor="placeholder">Placeholder text: </label>
<input
id="placeholder"
type="text"
value={placeholder}
onChange={e => this.setState({ placeholder: e.target.value })}
/>
</div>
<div style={{ marginBottom: '10px' }}>
<label htmlFor="inlinePlaceholderText">Inline placeholder text: </label>
<input
id="inlineSearchPlaceholder"
type="text"
value={inlineSearchPlaceholder}
onChange={e => this.setState({ inlineSearchPlaceholder: e.target.value })}
/>
</div>
<Checkbox
label="Inline Search Input"
value="inlineSearchInput"
Expand Down Expand Up @@ -132,7 +154,7 @@ class WithOptions extends PureComponent {
readOnly={readOnly}
inlineSearchInput={inlineSearchInput}
showDropdown={showDropdown}
texts={{ label: 'Demo Dropdown' }}
texts={{ label: 'Demo Dropdown', placeholder, inlineSearchPlaceholder }}
/>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class DropdownTreeSelect extends Component {
keepOpenOnSelect: PropTypes.bool,
texts: PropTypes.shape({
placeholder: PropTypes.string,
inlineSearchPlaceholder: PropTypes.string,
noMatches: PropTypes.string,
label: PropTypes.string,
labelRemove: PropTypes.string,
Expand Down Expand Up @@ -306,6 +307,7 @@ class DropdownTreeSelect extends Component {
onBlur={this.onInputBlur}
onKeyDown={this.onKeyboardKeyDown}
{...commonProps}
inlineSearchInput={inlineSearchInput}
/>
)
return (
Expand Down
16 changes: 14 additions & 2 deletions src/input/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,27 @@ class Input extends PureComponent {
}

render() {
const { inputRef, texts = {}, onFocus, onBlur, disabled, readOnly, onKeyDown, activeDescendant } = this.props
const {
inputRef,
texts = {},
onFocus,
onBlur,
disabled,
readOnly,
onKeyDown,
activeDescendant,
inlineSearchInput,
} = this.props

return (
<input
type="text"
disabled={disabled}
ref={inputRef}
className="search"
placeholder={texts.placeholder || 'Choose...'}
placeholder={
inlineSearchInput ? texts.inlineSearchPlaceholder || 'Search...' : texts.placeholder || 'Choose...'
}
onKeyDown={onKeyDown}
onChange={this.handleInputChange}
onFocus={onFocus}
Expand Down
8 changes: 8 additions & 0 deletions src/input/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ test('renders placeholder', t => {
t.snapshot(wrapper)
})

test('renders inline search placeholder', t => {
const placeholderText = 'Search something'
const wrapper = toJson(
shallow(<Input inlineSearchInput={true} texts={{ inlineSearchPlaceholder: placeholderText }} />)
)
t.snapshot(wrapper)
})

test('raises onchange', t => {
const onChange = spy()
const wrapper = shallow(<Input onInputChange={onChange} />)
Expand Down

0 comments on commit dd2dbbc

Please sign in to comment.