@gridui/select 1.1.2 → 1.2.1

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.
@@ -0,0 +1,127 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # Autocomplete
3
+
4
+ Suggests values while accepting arbitrary text. Arrow keys choose a suggestion; typing and dismissal preserve the native text value.
5
+
6
+ Import from ``@gridui/select`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { Autocomplete } from "@gridui/select";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/select/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/stories/autocomplete.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### children
23
+
24
+ ``ReactNode`` · Optional
25
+
26
+ Content rendered inside the component.
27
+
28
+ ### onFocus
29
+
30
+ ``(event: FocusEvent<HTMLInputElement, Element>): void`` · Optional
31
+
32
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
33
+
34
+ ### onBlur
35
+
36
+ ``(event: FocusEvent<HTMLInputElement, Element>): void`` · Optional
37
+
38
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
39
+
40
+ ### onChange
41
+
42
+ ``(event: ChangeEvent<HTMLInputElement, HTMLInputElement>): void`` · Optional
43
+
44
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
45
+
46
+ ### onSubmit
47
+
48
+ ``(event: SubmitEvent<HTMLInputElement>): void`` · Optional
49
+
50
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
51
+
52
+ ### onClick
53
+
54
+ ``(event: MouseEvent<HTMLInputElement, MouseEvent>): void`` · Optional
55
+
56
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
57
+
58
+ ### onValueChange
59
+
60
+ ``(value: string): void`` · Optional
61
+
62
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
63
+
64
+ ### controlSize
65
+
66
+ ``"small" | "standard" | undefined`` · Optional
67
+
68
+ ### loading
69
+
70
+ ``boolean | undefined`` · Optional
71
+
72
+ ### filterOptions
73
+
74
+ ``boolean | undefined`` · Optional
75
+
76
+ ### loadingLabel
77
+
78
+ ``string | undefined`` · Optional
79
+
80
+ ### errorLabel
81
+
82
+ ``string | undefined`` · Optional
83
+
84
+ ### resultCountLabel
85
+
86
+ ``((count: number) => string) | undefined`` · Optional
87
+
88
+ ### value
89
+
90
+ ``string | undefined`` · Optional
91
+
92
+ Controlled value. Pair with the corresponding change callback.
93
+
94
+ ### defaultValue
95
+
96
+ ``string | undefined`` · Optional
97
+
98
+ Default: ``""``
99
+
100
+ Initial uncontrolled value. Reset the story after changing it.
101
+
102
+ ### options
103
+
104
+ ``readonly (SelectOption | SelectGroup)[]`` · Required
105
+
106
+ ### searchLabel
107
+
108
+ ``string`` · Required
109
+
110
+ ### emptyLabel
111
+
112
+ ``string`` · Required
113
+
114
+ ### portalContainer
115
+
116
+ ``HTMLElement | undefined`` · Optional
117
+
118
+ ### rootClassName
119
+
120
+ ``string | undefined`` · Optional
121
+
122
+ ### onOptionSelect
123
+
124
+ ``(option: SelectOption): void`` · Optional
125
+
126
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
127
+
@@ -0,0 +1,149 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # Combobox
3
+
4
+ Combines text input with a list of selectable suggestions. Use it when users need to search a larger set of options.
5
+
6
+ Import from ``@gridui/select`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { Combobox } from "@gridui/select";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/select/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/stories/combobox.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### form
23
+
24
+ ``string | undefined`` · Optional
25
+
26
+ ### onFocus
27
+
28
+ ``(event: FocusEvent<HTMLInputElement, Element>): void`` · Optional
29
+
30
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
31
+
32
+ ### onBlur
33
+
34
+ ``(event: FocusEvent<HTMLInputElement, Element>): void`` · Optional
35
+
36
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
37
+
38
+ ### onSubmit
39
+
40
+ ``(event: SubmitEvent<HTMLInputElement>): void`` · Optional
41
+
42
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
43
+
44
+ ### onClick
45
+
46
+ ``(event: MouseEvent<HTMLInputElement, MouseEvent>): void`` · Optional
47
+
48
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
49
+
50
+ ### disabled
51
+
52
+ ``boolean | undefined`` · Optional
53
+
54
+ Prevents interaction when enabled.
55
+
56
+ ### name
57
+
58
+ ``string | undefined`` · Optional
59
+
60
+ Native form field name.
61
+
62
+ ### required
63
+
64
+ ``boolean | undefined`` · Optional
65
+
66
+ Participates in required form validation.
67
+
68
+ ### actions
69
+
70
+ ``readonly SelectAction[] | undefined`` · Optional
71
+
72
+ Default: ``[]``
73
+
74
+ ### controlSize
75
+
76
+ ``"small" | "standard" | undefined`` · Optional
77
+
78
+ Default: ``"standard"``
79
+
80
+ ### value
81
+
82
+ ``string | undefined`` · Optional
83
+
84
+ Controlled value. Pair with the corresponding change callback.
85
+
86
+ ### defaultValue
87
+
88
+ ``string | undefined`` · Optional
89
+
90
+ Default: ``""``
91
+
92
+ Initial uncontrolled value. Reset the story after changing it.
93
+
94
+ ### onValueChange
95
+
96
+ ``(value: string): void`` · Optional
97
+
98
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
99
+
100
+ ### clearLabel
101
+
102
+ ``string | undefined`` · Optional
103
+
104
+ ### portalContainer
105
+
106
+ ``HTMLElement | null | undefined`` · Optional
107
+
108
+ ### options
109
+
110
+ ``readonly (SelectOption | SelectGroup)[]`` · Required
111
+
112
+ ### query
113
+
114
+ ``string | undefined`` · Optional
115
+
116
+ ### onQueryChange
117
+
118
+ ``(query: string): void`` · Optional
119
+
120
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
121
+
122
+ ### filterOptions
123
+
124
+ ``boolean | undefined`` · Optional
125
+
126
+ ### loading
127
+
128
+ ``boolean | undefined`` · Optional
129
+
130
+ ### loadingLabel
131
+
132
+ ``string | undefined`` · Optional
133
+
134
+ ### errorLabel
135
+
136
+ ``string | undefined`` · Optional
137
+
138
+ ### resultCountLabel
139
+
140
+ ``((count: number) => string) | undefined`` · Optional
141
+
142
+ ### searchLabel
143
+
144
+ ``string`` · Required
145
+
146
+ ### emptyLabel
147
+
148
+ ``string`` · Required
149
+
@@ -0,0 +1,139 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # MultiSelect
3
+
4
+ Selects multiple options from a searchable popup. Use it when a field can hold a set of values.
5
+
6
+ Import from ``@gridui/select`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { MultiSelect } from "@gridui/select";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/select/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/stories/multi-select.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### form
23
+
24
+ ``string | undefined`` · Optional
25
+
26
+ ### onFocus
27
+
28
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
29
+
30
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
31
+
32
+ ### onBlur
33
+
34
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
35
+
36
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
37
+
38
+ ### onSubmit
39
+
40
+ ``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
41
+
42
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
43
+
44
+ ### onClick
45
+
46
+ ``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
47
+
48
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
49
+
50
+ ### disabled
51
+
52
+ ``boolean | undefined`` · Optional
53
+
54
+ Prevents interaction when enabled.
55
+
56
+ ### value
57
+
58
+ ``readonly string[] | undefined`` · Optional
59
+
60
+ Controlled value. Pair with the corresponding change callback.
61
+
62
+ ### defaultValue
63
+
64
+ ``readonly string[] | undefined`` · Optional
65
+
66
+ Initial uncontrolled value. Reset the story after changing it.
67
+
68
+ ### onValueChange
69
+
70
+ ``(value: string[]): void`` · Optional
71
+
72
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
73
+
74
+ ### readOnly
75
+
76
+ ``boolean | undefined`` · Optional
77
+
78
+ Allows reading without changing the value.
79
+
80
+ ### clearLabel
81
+
82
+ ``string | undefined`` · Optional
83
+
84
+ ### portalContainer
85
+
86
+ ``HTMLElement | null | undefined`` · Optional
87
+
88
+ ### required
89
+
90
+ ``boolean | undefined`` · Optional
91
+
92
+ Participates in required form validation.
93
+
94
+ ### options
95
+
96
+ ``readonly (SelectOption | SelectGroup)[]`` · Required
97
+
98
+ ### query
99
+
100
+ ``string | undefined`` · Optional
101
+
102
+ ### onQueryChange
103
+
104
+ ``(query: string): void`` · Optional
105
+
106
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
107
+
108
+ ### filterOptions
109
+
110
+ ``boolean | undefined`` · Optional
111
+
112
+ ### loading
113
+
114
+ ``boolean | undefined`` · Optional
115
+
116
+ ### loadingLabel
117
+
118
+ ``string | undefined`` · Optional
119
+
120
+ ### errorLabel
121
+
122
+ ``string | undefined`` · Optional
123
+
124
+ ### resultCountLabel
125
+
126
+ ``((count: number) => string) | undefined`` · Optional
127
+
128
+ ### searchLabel
129
+
130
+ ``string`` · Required
131
+
132
+ ### emptyLabel
133
+
134
+ ``string`` · Required
135
+
136
+ ### placeholder
137
+
138
+ ``string`` · Required
139
+
@@ -0,0 +1,121 @@
1
+ <!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
2
+ # Select
3
+
4
+ Chooses one value from a popup list. Use it when a compact form control is preferable to displaying every option inline.
5
+
6
+ Import from ``@gridui/select`` and load Theme before this family's stylesheet.
7
+
8
+ ```tsx
9
+ import { Select } from "@gridui/select";
10
+ import "@gridui/theme/styles.css";
11
+ import "@gridui/select/styles.css";
12
+ ```
13
+
14
+ Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/README.md) for shared behavior and stylesheet dependencies.
15
+
16
+ The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/select/stories/select.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
17
+
18
+ ## API
19
+
20
+ The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
21
+
22
+ ### form
23
+
24
+ ``string | undefined`` · Optional
25
+
26
+ ### onFocus
27
+
28
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
29
+
30
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
31
+
32
+ ### onBlur
33
+
34
+ ``(event: FocusEvent<HTMLButtonElement, Element>): void`` · Optional
35
+
36
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
37
+
38
+ ### onSubmit
39
+
40
+ ``(event: SubmitEvent<HTMLButtonElement>): void`` · Optional
41
+
42
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
43
+
44
+ ### onClick
45
+
46
+ ``(event: MouseEvent<HTMLButtonElement, MouseEvent>): void`` · Optional
47
+
48
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
49
+
50
+ ### disabled
51
+
52
+ ``boolean | undefined`` · Optional
53
+
54
+ Prevents interaction when enabled.
55
+
56
+ ### name
57
+
58
+ ``string | undefined`` · Optional
59
+
60
+ Native form field name.
61
+
62
+ ### actions
63
+
64
+ ``readonly SelectAction[] | undefined`` · Optional
65
+
66
+ Default: ``[]``
67
+
68
+ ### controlSize
69
+
70
+ ``"small" | "standard" | undefined`` · Optional
71
+
72
+ Default: ``"standard"``
73
+
74
+ ### value
75
+
76
+ ``string | undefined`` · Optional
77
+
78
+ Controlled value. Pair with the corresponding change callback.
79
+
80
+ ### defaultValue
81
+
82
+ ``string | undefined`` · Optional
83
+
84
+ Default: ``""``
85
+
86
+ Initial uncontrolled value. Reset the story after changing it.
87
+
88
+ ### onValueChange
89
+
90
+ ``(value: string): void`` · Optional
91
+
92
+ Called when the corresponding interaction occurs; inspect the arguments in Actions.
93
+
94
+ ### clearLabel
95
+
96
+ ``string | undefined`` · Optional
97
+
98
+ ### portalContainer
99
+
100
+ ``HTMLElement | null | undefined`` · Optional
101
+
102
+ ### required
103
+
104
+ ``boolean | undefined`` · Optional
105
+
106
+ Participates in required form validation.
107
+
108
+ ### options
109
+
110
+ ``readonly (SelectOption | SelectGroup)[]`` · Required
111
+
112
+ ### placeholder
113
+
114
+ ``string | undefined`` · Optional
115
+
116
+ ### position
117
+
118
+ ``"item-aligned" | "popper" | undefined`` · Optional
119
+
120
+ Default: ``"popper"``
121
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gridui/select",
3
- "version": "1.1.2",
3
+ "version": "1.2.1",
4
4
  "description": "GridUI React select",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",
@@ -27,11 +27,11 @@
27
27
  "react-dom": "^19.2.0"
28
28
  },
29
29
  "dependencies": {
30
- "@gridui/form": "^4.0.0",
31
- "@gridui/input": "^2.0.0",
30
+ "@gridui/form": "^4.1.1",
31
+ "@gridui/input": "^3.0.1",
32
32
  "@gridui/interaction": "^1.2.1",
33
33
  "@gridui/overlay": "^2.0.0",
34
- "@gridui/style-utils": "^3.0.0",
34
+ "@gridui/style-utils": "^4.0.0",
35
35
  "@gridui/theme": "^2.5.3",
36
36
  "@radix-ui/react-popover": "1.3.1",
37
37
  "@radix-ui/react-select": "2.4.1",