forge-select 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -15
- package/dist/index.cjs +667 -63
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +178 -9
- package/dist/index.d.ts +178 -9
- package/dist/index.global.js +1 -1
- package/dist/index.global.js.map +1 -1
- package/dist/index.js +667 -63
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/styles/forge-select.css +37 -1
package/README.md
CHANGED
|
@@ -140,21 +140,30 @@ Write and run Forge Select code in the browser at **<https://forgeselect.konexfo
|
|
|
140
140
|
|
|
141
141
|
## API Reference
|
|
142
142
|
|
|
143
|
-
| Option
|
|
144
|
-
|
|
|
145
|
-
| `placeholder`
|
|
146
|
-
| `searchable`
|
|
147
|
-
| `multiple`
|
|
148
|
-
| `clearable`
|
|
149
|
-
| `allowCreate`
|
|
150
|
-
| `sortable`
|
|
151
|
-
| `
|
|
152
|
-
| `
|
|
153
|
-
| `
|
|
154
|
-
| `
|
|
155
|
-
| `
|
|
156
|
-
| `
|
|
157
|
-
| `
|
|
143
|
+
| Option | Type | Default | Description |
|
|
144
|
+
| --------------------- | ---------------------------------- | ----------- | --------------------------------------------------- |
|
|
145
|
+
| `placeholder` | `string` | `""` | Text shown when nothing is selected |
|
|
146
|
+
| `searchable` | `boolean` | `true` | Show a search input in the dropdown |
|
|
147
|
+
| `multiple` | `boolean` | `false` | Allow selecting more than one option |
|
|
148
|
+
| `clearable` | `boolean` | `false` | Show a button to clear the current selection |
|
|
149
|
+
| `allowCreate` | `boolean` | `false` | Let the user create a new option from free text |
|
|
150
|
+
| `sortable` | `boolean` | `false` | Multi-select: let the user reorder selected tags |
|
|
151
|
+
| `closeOnSelect` | `boolean` | `false` | Multi-select: close the dropdown after each pick |
|
|
152
|
+
| `maxSelections` | `number` | `undefined` | Multi-select: caps the number of selected values |
|
|
153
|
+
| `theme` | `string` | `"default"` | Named theme applied to the control |
|
|
154
|
+
| `required` | `boolean` | `false` | Native form validation on a `<select>` mount |
|
|
155
|
+
| `data` | `Array<Option \| OptionGroup>` | `undefined` | Static options, used instead of `<option>` children |
|
|
156
|
+
| `ajax` | `AjaxConfig` | `undefined` | Remote data source config |
|
|
157
|
+
| `filterOption` | `(option, query) => boolean` | `undefined` | Custom match predicate for search filtering |
|
|
158
|
+
| `minSearchLength` | `number` | `0` | Minimum query length before filtering/ajax runs |
|
|
159
|
+
| `minResultsForSearch` | `number` | `0` | Hide local search below an option-count threshold |
|
|
160
|
+
| `isOptionDisabled` | `(option) => boolean` | `undefined` | Dynamically disable an option per render |
|
|
161
|
+
| `virtualScroll` | `boolean` | _(auto)_ | Virtualize the list once it exceeds ~100 rows |
|
|
162
|
+
| `itemHeight` | `number \| "auto"` | `36` | Fixed or measured variable-height virtual rows |
|
|
163
|
+
| `language` | `string \| Record<string, string>` | `"en"` | Locale code or a custom string table for i18n |
|
|
164
|
+
| `plugins` | `Array<ForgeSelectPlugin>` | `[]` | Plugins to register on this instance |
|
|
165
|
+
| `openOnFocus` | `boolean` | `false` | Open the dropdown on keyboard focus |
|
|
166
|
+
| `dropdownParent` | `HTMLElement \| string` | `undefined` | Portal container for overflow-constrained layouts |
|
|
158
167
|
|
|
159
168
|
Full constructor signature, all options, instance methods, and events are documented in [`docs/api-reference.md`](./docs/api-reference.md).
|
|
160
169
|
|