@decisiv/ui-components 2.0.1-alpha.99 → 2.0.1

package/lib/components/SearchInput/schema.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _reactDesc = require("react-desc");
+
+// @ts-ignore no module typings
+var schema = (0, _reactDesc.describe)({
+  displayName: 'SearchInput'
+});
+schema.propTypes = {
+  searchOn: _reactDesc.PropTypes.oneOf(['change', 'submit']).description('Set the behavior when the onSearch function is called').defaultValue('submit'),
+  debounceTimeout: _reactDesc.PropTypes.number.description('The amount of ms to wait until onSearch is called after the user has typed in the  search input').defaultValue('500'),
+  size: _reactDesc.PropTypes.oneOf(['medium', 'small']).description('Controls the size of the search input.').defaultValue('medium'),
+  disabled: _reactDesc.PropTypes.bool.description('Boolean indicating whether the search input is disabled.'),
+  searchDisabled: _reactDesc.PropTypes.bool.description('Boolean indicating whether only the search button is disabled.'),
+  value: _reactDesc.PropTypes.string.description('A text value to be displayed on the input field'),
+  onSearch: _reactDesc.PropTypes.func.description('A callback that is invoked with the input value when the the search action is performed'),
+  onChange: _reactDesc.PropTypes.func.description('A callback that is invoked when the value of the search field changes'),
+  searchByValue: _reactDesc.PropTypes.string.description('The ID of the option that is selected in the search by field. If provided, controlling the search by field must be handled externally.'),
+  searchByLabel: _reactDesc.PropTypes.string.description('Label for the search by field'),
+  searchByName: _reactDesc.PropTypes.string.description('Name for the search by field'),
+  searchInputRef: _reactDesc.PropTypes.object.description('A ref to the search input element, useful for focusing the input programmatically.'),
+  onSearchByChange: _reactDesc.PropTypes.func.description('A callback that is invoked when the value of the search by field changes'),
+  searchByOptions: _reactDesc.PropTypes.arrayOf(_reactDesc.PropTypes.shape({
+    id: _reactDesc.PropTypes.string.description('The id for an option in the search by list.'),
+    label: _reactDesc.PropTypes.string.description('The label text for an option in the search by list.'),
+    value: _reactDesc.PropTypes.string.description('The value for an option in the search by list.')
+  })).description('The array of data for the options that will be rendered in the search by field'),
+  searchByDefaultValue: _reactDesc.PropTypes.string.description('The ID of the option that should be selected by default in the search by field.'),
+  searchByWidth: _reactDesc.PropTypes.string.description('A pass-through CSS value for the search by field width attribute.'),
+  tooltipZIndex: _reactDesc.PropTypes.number.description('Sets the z-index style property of the tooltip component.')
+};
+var _default = schema;
+exports.default = _default;