@ceed/ads 1.23.1 โ 1.23.3
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/dist/components/data-display/Typography.md +17 -0
- package/dist/components/feedback/Dialog.md +8 -4
- package/dist/components/feedback/Modal.md +7 -3
- package/dist/components/inputs/Autocomplete.md +5 -0
- package/dist/components/inputs/CurrencyInput.md +5 -0
- package/dist/components/inputs/DatePicker.md +5 -0
- package/dist/components/inputs/DateRangePicker.md +5 -0
- package/dist/components/inputs/FilterableCheckboxGroup.md +5 -0
- package/dist/components/inputs/Input.md +5 -0
- package/dist/components/inputs/MonthPicker.md +5 -0
- package/dist/components/inputs/MonthRangePicker.md +5 -0
- package/dist/components/inputs/PercentageInput.md +5 -0
- package/dist/components/inputs/RadioTileGroup.md +5 -0
- package/dist/components/inputs/Select.md +5 -0
- package/dist/components/inputs/Textarea.md +5 -0
- package/package.json +1 -1
|
@@ -148,6 +148,23 @@ function ArticlePage() {
|
|
|
148
148
|
</Stack>
|
|
149
149
|
```
|
|
150
150
|
|
|
151
|
+
> ๐ก **Tip: Use built-in form props instead**
|
|
152
|
+
>
|
|
153
|
+
> Input, Select, Textarea, DatePicker ๋ฑ Input ๊ณ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` prop์ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
154
|
+
> Form์ ๊ตฌ์ฑํ ๋๋ Typography๋ก ์ง์ label/helperText๋ฅผ ๋ง๋๋ ๊ฒ๋ณด๋ค ๊ฐ ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ๋ ๊ฒ์ด ๊ถ์ฅ๋ฉ๋๋ค.
|
|
155
|
+
>
|
|
156
|
+
> ```tsx
|
|
157
|
+
> // โ
Recommended: ์ปดํฌ๋ํธ ๋ด์ฅ prop ์ฌ์ฉ
|
|
158
|
+
> <Input label="Username" helperText="Please enter your real name." />
|
|
159
|
+
>
|
|
160
|
+
> // โ Not recommended: Typography๋ก ์ง์ ๊ตฌ์ฑ
|
|
161
|
+
> <FormControl>
|
|
162
|
+
> <Typography level="title-sm" component="label">Username</Typography>
|
|
163
|
+
> <Input placeholder="Enter your name" />
|
|
164
|
+
> <Typography level="body-xs" color="neutral">Please enter your real name.</Typography>
|
|
165
|
+
> </FormControl>
|
|
166
|
+
> ```
|
|
167
|
+
|
|
151
168
|
### Status and Indicators
|
|
152
169
|
|
|
153
170
|
```tsx
|
|
@@ -98,12 +98,16 @@ DialogFrame can be used without a Modal wrapper for embedding dialog-style layou
|
|
|
98
98
|
|
|
99
99
|
> โ ๏ธ **Important** โ ๏ธ
|
|
100
100
|
>
|
|
101
|
-
> When using DialogFrame without Modal, the parent container **must**
|
|
102
|
-
>
|
|
103
|
-
>
|
|
101
|
+
> When using DialogFrame without Modal, the parent container **must** meet the following requirements:
|
|
102
|
+
>
|
|
103
|
+
> - `position: 'relative'` โ DialogFrame uses absolute positioning internally
|
|
104
|
+
> - Explicit `width` and `height` โ `height` must be an absolute value (e.g., `300`, `'400px'`), not a relative value like `%` or `auto`
|
|
105
|
+
>
|
|
106
|
+
> DialogFrame inherits its dimensions from `ModalDialog`, which normally receives sizing from the Modal overlay. Without these constraints, the component will not render with correct dimensions.
|
|
104
107
|
|
|
105
108
|
```tsx
|
|
106
109
|
<Box sx={{
|
|
110
|
+
position: 'relative',
|
|
107
111
|
width: 480,
|
|
108
112
|
height: 300
|
|
109
113
|
}}>
|
|
@@ -124,7 +128,7 @@ import { DialogFrame, Button, Box } from '@ceed/ads';
|
|
|
124
128
|
// Standalone usage requires explicit container dimensions
|
|
125
129
|
function EmbeddedDialog() {
|
|
126
130
|
return (
|
|
127
|
-
<Box sx={{ width: 480, height: 300 }}>
|
|
131
|
+
<Box sx={{ position: 'relative', width: 480, height: 300 }}>
|
|
128
132
|
<DialogFrame
|
|
129
133
|
title="Settings"
|
|
130
134
|
actions={
|
|
@@ -442,12 +442,16 @@ ModalFrame can be used without a Modal wrapper for embedding dialog-style layout
|
|
|
442
442
|
|
|
443
443
|
> โ ๏ธ **Important** โ ๏ธ
|
|
444
444
|
>
|
|
445
|
-
> When using ModalFrame without Modal, the parent container **must**
|
|
446
|
-
>
|
|
447
|
-
>
|
|
445
|
+
> When using ModalFrame without Modal, the parent container **must** meet the following requirements:
|
|
446
|
+
>
|
|
447
|
+
> - `position: 'relative'` โ ModalFrame uses absolute positioning internally
|
|
448
|
+
> - Explicit `width` and `height` โ `height` must be an absolute value (e.g., `300`, `'400px'`), not a relative value like `%` or `auto`
|
|
449
|
+
>
|
|
450
|
+
> ModalFrame inherits its dimensions from `ModalDialog`, which normally receives sizing from the Modal overlay. Without these constraints, the component will not render with correct dimensions.
|
|
448
451
|
|
|
449
452
|
```tsx
|
|
450
453
|
<Box sx={{
|
|
454
|
+
position: 'relative',
|
|
451
455
|
width: 480,
|
|
452
456
|
height: 300
|
|
453
457
|
}}>
|
|
@@ -22,6 +22,11 @@ Autocomplete is an enhanced input component that provides real-time suggestions
|
|
|
22
22
|
> - **Dropdown**: For action menus, not form value selection
|
|
23
23
|
> - **Input**: For free-text entry without predefined options
|
|
24
24
|
|
|
25
|
+
> ๐ก **Use built-in form props**
|
|
26
|
+
>
|
|
27
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
28
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
29
|
+
|
|
25
30
|
## Usage
|
|
26
31
|
|
|
27
32
|
```tsx
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Introduction
|
|
4
4
|
|
|
5
|
+
> ๐ก **Form ๊ตฌ์ฑ ์ ๋ด์ฅ prop ์ฌ์ฉ์ ๊ถ์ฅํฉ๋๋ค**
|
|
6
|
+
>
|
|
7
|
+
> ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` ๋ฑ์ Form ์์๋ฅผ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
8
|
+
> Form์ ๊ตฌ์ฑํ ๋ Typography๋ก ๋ณ๋์ label์ด๋ helperText๋ฅผ ๋ง๋๋ ๋์ , ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ์ธ์.
|
|
9
|
+
|
|
5
10
|
```tsx
|
|
6
11
|
<CurrencyInput
|
|
7
12
|
name="currency-input"
|
|
@@ -37,6 +37,11 @@ DatePicker is a form input component that allows users to select a single date f
|
|
|
37
37
|
> - **Date validation**: Invalid date strings can cause unexpected behavior
|
|
38
38
|
> - **Timezone considerations**: Be aware of timezone issues when working with dates
|
|
39
39
|
|
|
40
|
+
> ๐ก **Use built-in form props**
|
|
41
|
+
>
|
|
42
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
43
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
44
|
+
|
|
40
45
|
## Usage
|
|
41
46
|
|
|
42
47
|
```tsx
|
|
@@ -37,6 +37,11 @@ DateRangePicker is a form input component that allows users to select a date ran
|
|
|
37
37
|
> - **Start/End validation**: Ensure start date is before end date
|
|
38
38
|
> - **Range span**: Consider maximum range limits for performance and UX
|
|
39
39
|
|
|
40
|
+
> ๐ก **Use built-in form props**
|
|
41
|
+
>
|
|
42
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
43
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
44
|
+
|
|
40
45
|
## Usage
|
|
41
46
|
|
|
42
47
|
```tsx
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
FilterableCheckboxGroup ์ปดํฌ๋ํธ๋ ๋๋์ ์ต์
์ค์์ ์ฌ๋ฌ ํญ๋ชฉ์ ์ ํํ ์ ์๋ ๊ฒ์ ๊ฐ๋ฅํ ์ฒดํฌ๋ฐ์ค ๊ทธ๋ฃน์
๋๋ค. ๊ฒ์ ํํฐ๋ง๊ณผ ๊ฐ์ ์คํฌ๋กค๋ง์ ํตํด ๋ง์ ์์ ์ต์
์ ํจ์จ์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ผ๋ฉฐ, "Select all" ๊ธฐ๋ฅ์ผ๋ก ์ผ๊ด ์ ํ์ด ๊ฐ๋ฅํฉ๋๋ค. ํํฐ๋ง, ๋ค์ค ์ ํ ํผ, ์ค์ ํ๋ฉด ๋ฑ์์ ์ ์ฉํ๊ฒ ์ฌ์ฉ๋ฉ๋๋ค.
|
|
6
6
|
|
|
7
|
+
> ๐ก **Form ๊ตฌ์ฑ ์ ๋ด์ฅ prop ์ฌ์ฉ์ ๊ถ์ฅํฉ๋๋ค**
|
|
8
|
+
>
|
|
9
|
+
> ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` ๋ฑ์ Form ์์๋ฅผ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
10
|
+
> Form์ ๊ตฌ์ฑํ ๋ Typography๋ก ๋ณ๋์ label์ด๋ helperText๋ฅผ ๋ง๋๋ ๋์ , ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ์ธ์.
|
|
11
|
+
|
|
7
12
|
```tsx
|
|
8
13
|
<FilterableCheckboxGroup
|
|
9
14
|
label="Select Fruits"
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Input ์ปดํฌ๋ํธ๋ ์ฌ์ฉ์๋ก๋ถํฐ ํ
์คํธ ์
๋ ฅ์ ๋ฐ๊ธฐ ์ํ ๊ธฐ๋ณธ ์ปดํฌ๋ํธ์
๋๋ค. ๋ค์ํ ์คํ์ผ, ํฌ๊ธฐ ๋ฐ ๊ธฐ๋ฅ์ ์ง์ํฉ๋๋ค.
|
|
4
4
|
|
|
5
|
+
> ๐ก **Form ๊ตฌ์ฑ ์ ๋ด์ฅ prop ์ฌ์ฉ์ ๊ถ์ฅํฉ๋๋ค**
|
|
6
|
+
>
|
|
7
|
+
> ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` ๋ฑ์ Form ์์๋ฅผ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
8
|
+
> Form์ ๊ตฌ์ฑํ ๋ Typography๋ก ๋ณ๋์ label์ด๋ helperText๋ฅผ ๋ง๋๋ ๋์ , ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ์ธ์.
|
|
9
|
+
|
|
5
10
|
```tsx
|
|
6
11
|
<Input />
|
|
7
12
|
```
|
|
@@ -34,6 +34,11 @@ MonthPicker is a form input component that allows users to select a specific mon
|
|
|
34
34
|
> - **Format consistency**: Ensure your `value` prop matches the `format` prop
|
|
35
35
|
> - **displayFormat options**: Supports special token `MMMM` for full month names
|
|
36
36
|
|
|
37
|
+
> ๐ก **Use built-in form props**
|
|
38
|
+
>
|
|
39
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
40
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
41
|
+
|
|
37
42
|
## Usage
|
|
38
43
|
|
|
39
44
|
```tsx
|
|
@@ -34,6 +34,11 @@ MonthRangePicker is a form input component that allows users to select a range o
|
|
|
34
34
|
> - **Format consistency**: Both months in the range must match the `format` prop
|
|
35
35
|
> - **Month boundaries**: Consider inclusive vs exclusive range interpretations
|
|
36
36
|
|
|
37
|
+
> ๐ก **Use built-in form props**
|
|
38
|
+
>
|
|
39
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
40
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
41
|
+
|
|
37
42
|
## Usage
|
|
38
43
|
|
|
39
44
|
```tsx
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Introduction
|
|
4
4
|
|
|
5
|
+
> ๐ก **Form ๊ตฌ์ฑ ์ ๋ด์ฅ prop ์ฌ์ฉ์ ๊ถ์ฅํฉ๋๋ค**
|
|
6
|
+
>
|
|
7
|
+
> ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` ๋ฑ์ Form ์์๋ฅผ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
8
|
+
> Form์ ๊ตฌ์ฑํ ๋ Typography๋ก ๋ณ๋์ label์ด๋ helperText๋ฅผ ๋ง๋๋ ๋์ , ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ์ธ์.
|
|
9
|
+
|
|
5
10
|
```tsx
|
|
6
11
|
<PercentageInput placeholder="Enter a percentage" />
|
|
7
12
|
```
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
RadioTileGroup ์ปดํฌ๋ํธ๋ ํ์ผ ํํ์ ๋ผ๋์ค ์ต์
์ ํ์ํ๋ ์ปดํฌ๋ํธ์
๋๋ค. ๊ฐ ์ต์
์ด ํ์ผ ํํ๋ก ๋ํ๋๋ฉฐ, ์ฌ์ฉ์๊ฐ ์ ํํ ์ ์์ต๋๋ค.
|
|
4
4
|
|
|
5
|
+
> ๐ก **Form ๊ตฌ์ฑ ์ ๋ด์ฅ prop ์ฌ์ฉ์ ๊ถ์ฅํฉ๋๋ค**
|
|
6
|
+
>
|
|
7
|
+
> ์ด ์ปดํฌ๋ํธ๋ `label`, `helperText` ๋ฑ์ Form ์์๋ฅผ ์์ฒด์ ์ผ๋ก ์ง์ํฉ๋๋ค.
|
|
8
|
+
> Form์ ๊ตฌ์ฑํ ๋ Typography๋ก ๋ณ๋์ label์ด๋ helperText๋ฅผ ๋ง๋๋ ๋์ , ์ปดํฌ๋ํธ์ ๋ด์ฅ prop์ ์ฌ์ฉํ์ธ์.
|
|
9
|
+
|
|
5
10
|
```tsx
|
|
6
11
|
<RadioTileGroup
|
|
7
12
|
options={simpleOptions}
|
|
@@ -35,6 +35,11 @@ The Select component is a form input that allows users to choose one or multiple
|
|
|
35
35
|
> - More than 20 options โ Consider Autocomplete with search
|
|
36
36
|
> - Actions/navigation โ Use Dropdown with Menu
|
|
37
37
|
|
|
38
|
+
> ๐ก **Use built-in form props**
|
|
39
|
+
>
|
|
40
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
41
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
42
|
+
|
|
38
43
|
## Usage
|
|
39
44
|
|
|
40
45
|
```tsx
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Introduction
|
|
4
4
|
|
|
5
|
+
> ๐ก **Use built-in form props**
|
|
6
|
+
>
|
|
7
|
+
> This component natively supports form elements such as `label` and `helperText` props.
|
|
8
|
+
> When building forms, use these built-in props instead of manually composing labels and helper text with Typography.
|
|
9
|
+
|
|
5
10
|
```tsx
|
|
6
11
|
<Textarea name="Textarea" />
|
|
7
12
|
```
|