react-form-suffixes-select
A React select component that displays name suffixes (II, Sr, PhD) for react forms and fires a callback when a new one is selected.
Installation
yarn add react-form-suffixes-select - or - npm install react-form-suffixes-select
Usage
1 . Require react-form-suffixes-select after installation
;
2 . Include react-form-suffixes-select component
{ // event {SyntheticEvent<HTMLSelectElement>} - React HTML event // prefix {Object} - Object representing the suffix // suffix.label {string} - The display label of the selected suffix // suffix.code {string} - The two or three letter abbreviation of the suffix (unique to the collection)} <SuffixesSelect onChange=thisonSuffixSelect />
Parameters
Parameter | Type | Description |
---|---|---|
onChange | function |
Callback with the selected suffix. Parameters are the HTML event and an object with the format { label: 'Sr', code: 'SR' } |
defaultOptionText | string |
The label to display for the default/unselected option. A user selecting this option will not fire the callback. (default: "Suffix") |
hasDefaultOption | boolean |
Toggle the default option on or off (default: true) |
style | Object |
Javascript object with camelCased CSS properties rather than a CSS string. Standard React styles |
className | string |
A CSS class name. The presence of this attribute will override all default styles. So it's all or none |
Build
yarn run buildnpm run build
Test
yarn run testnpm run test
Lint
yarn run lintnpm run lint
Flow
yarn run flownpm run flow
License
MIT