@ceed/ads 1.30.0 → 1.30.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.
Files changed (62) hide show
  1. package/dist/Overview.md +5 -5
  2. package/dist/components/data-display/Avatar.md +85 -74
  3. package/dist/components/data-display/Badge.md +23 -5
  4. package/dist/components/data-display/Chip.md +49 -35
  5. package/dist/components/data-display/DataTable.md +93 -0
  6. package/dist/components/data-display/InfoSign.md +15 -5
  7. package/dist/components/data-display/Markdown.md +22 -26
  8. package/dist/components/data-display/Table.md +63 -53
  9. package/dist/components/data-display/Tooltip.md +70 -58
  10. package/dist/components/data-display/Typography.md +28 -11
  11. package/dist/components/feedback/Alert.md +86 -74
  12. package/dist/components/feedback/CircularProgress.md +20 -5
  13. package/dist/components/feedback/Dialog.md +8 -12
  14. package/dist/components/feedback/Modal.md +12 -16
  15. package/dist/components/feedback/Skeleton.md +20 -5
  16. package/dist/components/inputs/Autocomplete.md +8 -10
  17. package/dist/components/inputs/Button.md +107 -87
  18. package/dist/components/inputs/ButtonGroup.md +20 -5
  19. package/dist/components/inputs/Calendar.md +25 -5
  20. package/dist/components/inputs/Checkbox.md +171 -450
  21. package/dist/components/inputs/CurrencyInput.md +25 -5
  22. package/dist/components/inputs/DatePicker.md +39 -5
  23. package/dist/components/inputs/DateRangePicker.md +29 -5
  24. package/dist/components/inputs/FilterMenu.md +85 -9
  25. package/dist/components/inputs/FilterableCheckboxGroup.md +23 -8
  26. package/dist/components/inputs/FormControl.md +34 -6
  27. package/dist/components/inputs/IconButton.md +21 -5
  28. package/dist/components/inputs/Input.md +254 -68
  29. package/dist/components/inputs/MonthPicker.md +28 -5
  30. package/dist/components/inputs/MonthRangePicker.md +26 -5
  31. package/dist/components/inputs/PercentageInput.md +28 -5
  32. package/dist/components/inputs/RadioButton.md +26 -5
  33. package/dist/components/inputs/RadioList.md +23 -6
  34. package/dist/components/inputs/RadioTileGroup.md +40 -8
  35. package/dist/components/inputs/Select.md +59 -5
  36. package/dist/components/inputs/Slider.md +26 -5
  37. package/dist/components/inputs/Switch.md +23 -5
  38. package/dist/components/inputs/Textarea.md +27 -5
  39. package/dist/components/inputs/Uploader/Uploader.md +24 -5
  40. package/dist/components/layout/Box.md +66 -58
  41. package/dist/components/layout/Container.md +9 -13
  42. package/dist/components/layout/Grid.md +91 -75
  43. package/dist/components/layout/Stack.md +85 -70
  44. package/dist/components/navigation/Breadcrumbs.md +23 -14
  45. package/dist/components/navigation/Dropdown.md +29 -20
  46. package/dist/components/navigation/IconMenuButton.md +24 -11
  47. package/dist/components/navigation/InsetDrawer.md +16 -5
  48. package/dist/components/navigation/Link.md +30 -14
  49. package/dist/components/navigation/Menu.md +33 -20
  50. package/dist/components/navigation/MenuButton.md +26 -12
  51. package/dist/components/navigation/NavigationGroup.md +7 -11
  52. package/dist/components/navigation/NavigationItem.md +8 -12
  53. package/dist/components/navigation/Navigator.md +5 -9
  54. package/dist/components/navigation/Pagination.md +21 -12
  55. package/dist/components/navigation/ProfileMenu.md +17 -5
  56. package/dist/components/navigation/Stepper.md +18 -5
  57. package/dist/components/navigation/Tabs.md +37 -14
  58. package/dist/components/surfaces/Accordions.md +12 -16
  59. package/dist/components/surfaces/Card.md +59 -47
  60. package/dist/components/surfaces/Divider.md +70 -61
  61. package/dist/components/surfaces/Sheet.md +18 -5
  62. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Introduction
4
4
 
5
- Box 가장 기본적이고 중요한 레이아웃 컴포넌트입니다. 다른 컴포넌트들을 감싸는 범용 컨테이너 역할을 하며, CSS-in-JS 통해 스타일을 직접 적용할 수 있습니다. Framer Motion 내장되어 있어 애니메이션 효과도 쉽게 추가할 있습니다. 모든 HTML 요소로 변환 가능한 다형성(polymorphic) 컴포넌트이기도 합니다.
5
+ Box is the most fundamental and essential layout component. It acts as a general-purpose container that wraps other components, and you can apply styles directly through CSS-in-JS. It also includes built-in Framer Motion support, making it easy to add animations. It is also a polymorphic component that can render as any HTML element.
6
6
 
7
7
  ```tsx
8
8
  <Box {...args} sx={{
@@ -44,11 +44,9 @@ function MyComponent() {
44
44
  }
45
45
  ```
46
46
 
47
- ## Examples
47
+ ## Box Basic Usage
48
48
 
49
- ### Basic Usage
50
-
51
- 가장 기본적인 Box 사용법입니다.
49
+ The most basic way to use Box.
52
50
 
53
51
  ```tsx
54
52
  <div style={{
@@ -84,9 +82,9 @@ function MyComponent() {
84
82
  </div>
85
83
  ```
86
84
 
87
- ### Colors
85
+ ## Box Colors
88
86
 
89
- 다양한 배경색을 적용할 있습니다.
87
+ You can apply various background colors.
90
88
 
91
89
  ```tsx
92
90
  <div style={{
@@ -136,9 +134,9 @@ function MyComponent() {
136
134
  </div>
137
135
  ```
138
136
 
139
- ### Spacing
137
+ ## Box Spacing
140
138
 
141
- 패딩과 마진을 조절할 있습니다.
139
+ You can adjust padding and margin.
142
140
 
143
141
  ```tsx
144
142
  <div style={{
@@ -213,9 +211,9 @@ function MyComponent() {
213
211
  </div>
214
212
  ```
215
213
 
216
- ### Border Radius
214
+ ## Box Border Radius
217
215
 
218
- 모서리 둥글기를 다양하게 설정할 있습니다.
216
+ You can configure different corner radius values.
219
217
 
220
218
  ```tsx
221
219
  <div style={{
@@ -297,9 +295,9 @@ function MyComponent() {
297
295
  </div>
298
296
  ```
299
297
 
300
- ### Shadows
298
+ ## Box Shadows
301
299
 
302
- 그림자 효과를 추가할 있습니다.
300
+ You can add shadow effects.
303
301
 
304
302
  ```tsx
305
303
  <div style={{
@@ -388,9 +386,9 @@ function MyComponent() {
388
386
  </div>
389
387
  ```
390
388
 
391
- ### Flex Layouts
389
+ ## Box Flex Layouts
392
390
 
393
- Flexbox를 사용한 레이아웃을 쉽게 만들 있습니다.
391
+ You can easily build layouts using Flexbox.
394
392
 
395
393
  ```tsx
396
394
  <div style={{
@@ -497,9 +495,9 @@ Flexbox를 사용한 레이아웃을 쉽게 만들 수 있습니다.
497
495
  </div>
498
496
  ```
499
497
 
500
- ### Responsive Layout
498
+ ## Box Responsive Layout
501
499
 
502
- 반응형 레이아웃을 구현할 있습니다.
500
+ You can create responsive layouts.
503
501
 
504
502
  ```tsx
505
503
  <div style={{
@@ -549,9 +547,9 @@ Flexbox를 사용한 레이아웃을 쉽게 만들 수 있습니다.
549
547
  </div>
550
548
  ```
551
549
 
552
- ### Polymorphic Components
550
+ ## Box Polymorphic Components
553
551
 
554
- component prop을 사용하여 다양한 HTML 요소로 렌더링할 있습니다.
552
+ You can render it as different HTML elements using the `component` prop.
555
553
 
556
554
  ```tsx
557
555
  <div style={{
@@ -601,9 +599,9 @@ component prop을 사용하여 다양한 HTML 요소로 렌더링할 수 있습
601
599
  </div>
602
600
  ```
603
601
 
604
- ### Motion Animations
602
+ ## Box Motion Animations
605
603
 
606
- 내장된 Framer Motion을 사용한 애니메이션 효과입니다.
604
+ Animation effects using built-in Framer Motion.
607
605
 
608
606
  ```tsx
609
607
  <div style={{
@@ -653,9 +651,9 @@ component prop을 사용하여 다양한 HTML 요소로 렌더링할 수 있습
653
651
  </div>
654
652
  ```
655
653
 
656
- ### Complex Layouts
654
+ ## Box Complex Layouts
657
655
 
658
- Box 조합하여 복잡한 레이아웃을 만들 수 있습니다.
656
+ You can combine Box components to build complex layouts.
659
657
 
660
658
  ```tsx
661
659
  <div style={{
@@ -790,16 +788,16 @@ Box를 조합하여 복잡한 레이아웃을 만들 수 있습니다.
790
788
 
791
789
  ### SX Prop
792
790
 
793
- Box 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타일을 객체 형태로 직접 적용할 있습니다.
791
+ The most powerful feature of Box is the `sx` prop. It allows you to apply CSS styles directly as an object.
794
792
 
795
793
  ```tsx
796
794
  <Box
797
795
  sx={{
798
796
  p: 2, // padding: 16px
799
- m: { xs: 1, md: 2 }, // 반응형 마진
800
- bgcolor: 'primary.50', // 테마 색상
801
- borderRadius: 'md', // 테마 border-radius
802
- '&:hover': { // hover 상태
797
+ m: { xs: 1, md: 2 }, // responsive margin
798
+ bgcolor: 'primary.50', // theme color
799
+ borderRadius: 'md', // theme border-radius
800
+ '&:hover': { // hover state
803
801
  bgcolor: 'primary.100',
804
802
  },
805
803
  }}
@@ -810,7 +808,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
810
808
 
811
809
  ### Responsive Design
812
810
 
813
- 객체 구문을 사용해 브레이크포인트별 스타일을 지정할 있습니다.
811
+ You can define styles per breakpoint using object syntax.
814
812
 
815
813
  ```tsx
816
814
  <Box
@@ -826,7 +824,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
826
824
 
827
825
  ### Theme Integration
828
826
 
829
- 디자인 시스템의 토큰을 직접 사용할 있습니다.
827
+ You can use design system tokens directly.
830
828
 
831
829
  ```tsx
832
830
  <Box
@@ -843,7 +841,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
843
841
 
844
842
  ### Framer Motion
845
843
 
846
- 애니메이션 props를 직접 사용할 있습니다.
844
+ You can use animation props directly.
847
845
 
848
846
  ```tsx
849
847
  <Box
@@ -856,9 +854,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
856
854
  </Box>
857
855
  ```
858
856
 
859
- ## Common Use Cases
860
-
861
- ### Layout Container
857
+ ## Box Layout Container
862
858
 
863
859
  ```tsx
864
860
  <Box sx={{ maxWidth: 1200, mx: 'auto', p: 3 }}>
@@ -867,7 +863,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
867
863
  </Box>
868
864
  ```
869
865
 
870
- ### Card-like Components
866
+ ## Box Card-like Components
871
867
 
872
868
  ```tsx
873
869
  <Box
@@ -885,7 +881,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
885
881
  </Box>
886
882
  ```
887
883
 
888
- ### Flexbox Layouts
884
+ ## Box Flexbox Layouts
889
885
 
890
886
  ```tsx
891
887
  <Box sx={{ display: 'flex', gap: 2, alignItems: 'center' }}>
@@ -897,7 +893,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
897
893
  </Box>
898
894
  ```
899
895
 
900
- ### Grid Layouts
896
+ ## Box Grid Layouts
901
897
 
902
898
  ```tsx
903
899
  <Box
@@ -915,7 +911,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
915
911
  </Box>
916
912
  ```
917
913
 
918
- ### Centered Content
914
+ ## Box Centered Content
919
915
 
920
916
  ```tsx
921
917
  <Box
@@ -930,7 +926,7 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
930
926
  </Box>
931
927
  ```
932
928
 
933
- ### Sticky/Fixed Positioning
929
+ ## Box Sticky and Fixed Positioning
934
930
 
935
931
  ```tsx
936
932
  <Box
@@ -947,34 +943,46 @@ Box의 가장 강력한 기능은 `sx` prop입니다. 이를 통해 CSS 스타
947
943
  </Box>
948
944
  ```
949
945
 
946
+ ## Props and Customization
947
+
948
+ ### Key Props
949
+
950
+ | Prop | Type | Default | Description |
951
+ | ----------- | ------------- | ------- | ---------------------------------- |
952
+ | `children` | `ReactNode` | - | Content inside the box |
953
+ | `component` | `ElementType` | `'div'` | Root element type |
954
+ | `sx` | `SxProps` | - | Custom styles using the MUI system |
955
+
956
+ Box is a general-purpose container that renders as a `<div>` by default. It accepts all standard HTML attributes and Joy UI's `sx` prop for responsive styling.
957
+
950
958
  ## Best Practices
951
959
 
952
- 1. **의미 있는 HTML 요소 사용**: `component` prop 활용해 의미론적으로 올바른 HTML 요소를 선택하세요.
960
+ 1. **Use meaningful HTML elements**: Use the `component` prop to choose semantically appropriate HTML elements.
953
961
 
954
- 2. **테마 토큰 활용**: 하드코딩된 대신 테마의 spacing, color, border-radius 등을 사용하세요.
962
+ 2. **Use theme tokens**: Use theme spacing, color, border-radius, and similar values instead of hardcoded values.
955
963
 
956
- 3. **반응형 고려**: 다양한 화면 크기에서 동작하도록 반응형 값을 사용하세요.
964
+ 3. **Design responsively**: Use responsive values so the component works well across different screen sizes.
957
965
 
958
- 4. **성능 최적화**:
959
- - 인라인 객체 생성을 피하고 가능하면 객체를 메모화하세요
960
- - 복잡한 애니메이션은 필요할 때만 사용하세요
966
+ 4. **Optimize performance**:
967
+ - Avoid creating inline objects repeatedly, and memoize them when possible
968
+ - Use complex animations only when necessary
961
969
 
962
- 5. **접근성**:
963
- - 적절한 semantic HTML 요소를 선택하세요
964
- - 필요시 ARIA 속성을 추가하세요
965
- - 충분한 색상 대비를 유지하세요
970
+ 5. **Consider accessibility**:
971
+ - Choose appropriate semantic HTML elements
972
+ - Add ARIA attributes when needed
973
+ - Maintain sufficient color contrast
966
974
 
967
- 6. **재사용성**:
968
- - 자주 사용하는 스타일 조합은 별도 컴포넌트로 분리하세요
969
- - 공통 스타일은 테마에 정의하세요
975
+ 6. **Promote reusability**:
976
+ - Extract frequently used style combinations into separate components
977
+ - Define shared styles in the theme
970
978
 
971
- 7. **일관성**:
972
- - 내에서 일관된 spacing naming convention을 사용하세요
973
- - 디자인 시스템의 가이드라인을 따르세요
979
+ 7. **Maintain consistency**:
980
+ - Use consistent spacing and naming conventions across the team
981
+ - Follow the design system guidelines
974
982
 
975
983
  ## Spacing Scale
976
984
 
977
- Box에서 사용할 있는 spacing 값들:
985
+ Spacing values available in Box:
978
986
 
979
987
  - `0.5` = 4px
980
988
  - `1` = 8px
@@ -987,11 +995,11 @@ Box에서 사용할 수 있는 spacing 값들:
987
995
 
988
996
  ## Color Tokens
989
997
 
990
- 주요 색상 토큰들:
998
+ Primary color tokens:
991
999
 
992
1000
  - **Background**: `background.body`, `background.surface`, `background.level1`
993
1001
  - **Primary**: `primary.50`, `primary.100`, `primary.500`, `primary.main`
994
1002
  - **Neutral**: `neutral.50`, `neutral.100`, `neutral.500`, `neutral.main`
995
1003
  - **Text**: `text.primary`, `text.secondary`, `text.tertiary`
996
1004
 
997
- Box ADS의 모든 레이아웃과 스타일링의 기초가 되는 컴포넌트입니다. 강력한 sx prop 내장된 애니메이션 기능을 활용해 다양한 UI 요구사항을 충족할 있습니다.
1005
+ Box is the foundational component for all layout and styling in ADS. Its powerful `sx` prop and built-in animation support make it flexible enough to satisfy a wide range of UI requirements.
@@ -33,9 +33,7 @@ function PageLayout() {
33
33
  }
34
34
  ```
35
35
 
36
- ## Examples
37
-
38
- ### Desktop
36
+ ## Container Desktop
39
37
 
40
38
  Maximum width optimized for desktop screens (widest setting).
41
39
 
@@ -49,7 +47,7 @@ Maximum width optimized for desktop screens (widest setting).
49
47
  />
50
48
  ```
51
49
 
52
- ### Laptop
50
+ ## Container Laptop
53
51
 
54
52
  Medium maximum width suitable for laptop screens.
55
53
 
@@ -63,7 +61,7 @@ Medium maximum width suitable for laptop screens.
63
61
  />
64
62
  ```
65
63
 
66
- ### Tablet
64
+ ## Container Tablet
67
65
 
68
66
  Narrower maximum width for tablet-optimized layouts.
69
67
 
@@ -96,9 +94,7 @@ Narrower maximum width for tablet-optimized layouts.
96
94
  - **Navigation bars**: Usually span full width
97
95
  - **Background elements**: Elements that should fill the screen
98
96
 
99
- ## Common Use Cases
100
-
101
- ### Page Layout with Header
97
+ ## Container for Page Layout
102
98
 
103
99
  ```tsx
104
100
  function PageWithHeader() {
@@ -123,7 +119,7 @@ function PageWithHeader() {
123
119
  }
124
120
  ```
125
121
 
126
- ### Centered Form Layout
122
+ ## Container for Centered Form
127
123
 
128
124
  ```tsx
129
125
  function CenteredForm() {
@@ -154,7 +150,7 @@ function CenteredForm() {
154
150
  }
155
151
  ```
156
152
 
157
- ### Article/Blog Layout
153
+ ## Container for Article/Blog Layout
158
154
 
159
155
  ```tsx
160
156
  function ArticlePage({ article }) {
@@ -180,7 +176,7 @@ function ArticlePage({ article }) {
180
176
  }
181
177
  ```
182
178
 
183
- ### Dashboard with Cards
179
+ ## Container for Dashboard Layout
184
180
 
185
181
  ```tsx
186
182
  function Dashboard() {
@@ -237,7 +233,7 @@ function Dashboard() {
237
233
  }
238
234
  ```
239
235
 
240
- ### Responsive Container Selection
236
+ ## Container Responsive Selection
241
237
 
242
238
  ```tsx
243
239
  function ResponsiveLayout({ children }) {
@@ -255,7 +251,7 @@ function ResponsiveLayout({ children }) {
255
251
  }
256
252
  ```
257
253
 
258
- ### Nested Containers
254
+ ## Nested Containers
259
255
 
260
256
  ```tsx
261
257
  function PageWithSections() {