Skip to content

Commit fb62e29

Browse files
committed
fix: Update docs
1 parent 0cce285 commit fb62e29

File tree

19 files changed

+39
-47
lines changed

19 files changed

+39
-47
lines changed

src/app/components/auto-complete/auto-complete.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ AutoComplete control of input field.
4949
/>
5050

5151
<Playground
52+
title="Disabled"
5253
desc="Disable all."
53-
title="disabled"
5454
scope={{ AutoComplete }}
5555
code={`
5656
() => {
@@ -81,8 +81,8 @@ AutoComplete control of input field.
8181
/>
8282

8383
<Playground
84+
title="Search"
8485
desc="Update the contents of drop-down list based on input."
85-
title="search"
8686
scope={{ AutoComplete }}
8787
code={`
8888
() => {
@@ -141,7 +141,7 @@ AutoComplete control of input field.
141141
/>
142142

143143
<Playground
144-
title="custom searching text"
144+
title="Custom searching text"
145145
desc="You can replace the default waiting text with any components."
146146
scope={{ AutoComplete }}
147147
code={`
@@ -154,7 +154,7 @@ AutoComplete control of input field.
154154
/>
155155

156156
<Playground
157-
title="custom no options"
157+
title="Custom no options"
158158
desc="You can also customize the prompt with no options."
159159
scope={{ AutoComplete, useState }}
160160
code={`
@@ -182,7 +182,7 @@ AutoComplete control of input field.
182182
/>
183183

184184
<Playground
185-
title="custom option"
185+
title="Custom option"
186186
desc="You can rewrite each item of the `AutoComplete` to express more."
187187
scope={{ AutoComplete, useState, Text, Badge, Grid }}
188188
code={`
@@ -221,7 +221,7 @@ AutoComplete control of input field.
221221
/>
222222

223223
<Playground
224-
title="clearable"
224+
title="Clearable"
225225
desc="Add a clear button in the input box."
226226
scope={{ AutoComplete }}
227227
code={`

src/app/components/button/button.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The `Button` UI component is a versatile element for triggering various operatio
7474
/>
7575

7676
<Playground
77-
title="GHOST"
77+
title="Ghost"
7878
desc="The opposite color."
7979
scope={{ Button, Grid }}
8080
code={`

src/app/components/checkbox/checkbox.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Displays a boolean value.
1919
/>
2020

2121
<Playground
22-
title="sizes"
22+
title="Size"
2323
desc="Checkbox of different sizes."
2424
scope={{ Checkbox }}
2525
code={`
@@ -49,7 +49,7 @@ Displays a boolean value.
4949
/>
5050

5151
<Playground
52-
title="disable"
52+
title="Disabled"
5353
scope={{ Checkbox, Spacer }}
5454
code={`
5555
<>
@@ -61,7 +61,7 @@ Displays a boolean value.
6161
/>
6262

6363
<Playground
64-
title="group"
64+
title="Group"
6565
desc="Manage a set of `Checkbox`."
6666
scope={{ Checkbox, Spacer }}
6767
code={`

src/app/components/count-up/count-up.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ export const meta = {
1212
`CountUp` is used to show animation counter
1313

1414
<Playground
15-
title="CountUp example"
1615
desc="Example of Countup"
1716
scope={{ CountUp, Text, Button }}
1817
code={`

src/app/components/input/input.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The Input contain an additional Hooks, see subsection [useInput](/hooks/use-inpu
3131
/>
3232

3333
<Playground
34-
title="Sizes"
34+
title="Size"
3535
desc="Inputs of different sizes."
3636
scope={{ Input, Spacer }}
3737
code={`

src/app/components/keyboard/keyboard.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `Keyboard` can only display layout styles, if you need to bind the keyboard
2020
/>
2121

2222
<Playground
23-
title="modifiers"
23+
title="Modifiers"
2424
scope={{ Keyboard }}
2525
code={`
2626
<div>
@@ -33,7 +33,7 @@ The `Keyboard` can only display layout styles, if you need to bind the keyboard
3333
/>
3434

3535
<Playground
36-
title="combination"
36+
title="Combination"
3737
scope={{ Keyboard }}
3838
code={`
3939
<div>

src/app/components/link/link.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Hyperlinks between pages.
1919
/>
2020

2121
<Playground
22-
title="highlight"
22+
title="Highlight"
2323
desc="Distinguish links with different colors."
2424
scope={{ Link }}
2525
code={`
@@ -41,7 +41,7 @@ Hyperlinks between pages.
4141
/>
4242

4343
<Playground
44-
title="variant"
44+
title="Variant"
4545
desc="Different styles of links."
4646
scope={{ Link, Text }}
4747
code={`
@@ -57,7 +57,7 @@ Hyperlinks between pages.
5757
/>
5858

5959
<Playground
60-
title="block"
60+
title="Block"
6161
desc="Display as a separate block."
6262
scope={{ Link }}
6363
code={`

src/app/components/loading-spinner/loading-spinner.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Indicate an action running in the background.
1818
/>
1919

2020
<Playground
21-
title="with text"
21+
title="With text"
2222
desc="Customize text next to icon."
2323
scope={{ LoadingSpinner }}
2424
code={`
@@ -27,7 +27,7 @@ Indicate an action running in the background.
2727
/>
2828

2929
<Playground
30-
title="types"
30+
title="Types"
3131
desc="Loading indicators in different states."
3232
scope={{ LoadingSpinner, Grid }}
3333
code={`
@@ -49,7 +49,7 @@ Indicate an action running in the background.
4949
/>
5050

5151
<Playground
52-
title="spaces"
52+
title="Spaces"
5353
desc="Customize the space between points. (the ratio is relative to the current `size`)"
5454
scope={{ LoadingSpinner, Grid }}
5555
code={`

src/app/components/menu/menu.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Easily create and customize menus for your applications with the `Menu` UI compo
1414

1515
<Playground
1616
scope={{ Menu, Link, Home }}
17-
title={'Menu example'}
1817
desc={'Example of a menu'}
1918
code={`
2019
() => {

src/app/components/note/note.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Display text that requires attention or provides additional information.
1919
/>
2020

2121
<Playground
22-
title="secondary"
22+
title="Secondary"
2323
scope={{ Note }}
2424
code={`
2525
<Note type="secondary">This note details something important.</Note>
2626
`}
2727
/>
2828

2929
<Playground
30-
title="status"
30+
title="Status"
3131
scope={{ Note }}
3232
code={`
3333
<>
@@ -41,7 +41,7 @@ Display text that requires attention or provides additional information.
4141
/>
4242

4343
<Playground
44-
title="custom label"
44+
title="Custom label"
4545
scope={{ Note }}
4646
code={`
4747
<Note icon="custom">This note uses a custom label.</Note>

src/app/components/page-width/page-width.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const meta = {
66
group: 'Layout',
77
}
88

9-
# PageWidth (formerly `ContentLayout`)
9+
# PageWidth
1010

1111
Displays the content with maximum page width given by the ui provider with equal margins from left and right.
1212

src/app/components/quick-bar/quick-bar.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ export const meta = {
1313
QuickBar is a customizable sidebar component designed for navigation .
1414

1515
<Playground
16-
title="Example"
1716
scope={{
1817
QuickAction,
1918
Code,

src/app/components/search/search.mdx

-3
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ export const meta = {
1515
# Search
1616
The `Search` UI component provides a flexible and customizable search modal for web applications.
1717

18-
## Page search modal
19-
2018
<Playground
21-
title="Search modal example"
2219
desc="A fully example of using the search modal"
2320
scope={{ Search, Button, useState, SearchProvider }}
2421
code={`

src/app/components/section/section.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The `Section` UI component offers a versatile container for organizing and struc
1212

1313
<Playground
1414
scope={{ Section, Text }}
15-
title={'Section example'}
1615
desc={'Example of a section'}
1716
code={`
1817
<Section>
@@ -23,7 +22,7 @@ The `Section` UI component offers a versatile container for organizing and struc
2322

2423
<Playground
2524
scope={{ Section, Text }}
26-
title={'Section example responsive'}
25+
title={'Responsive Section'}
2726
desc={'Example of a section responsive'}
2827
code={`
2928
<Section p={{ xs: 2, md: 4, xl: 6 }}>

src/app/components/snippet/snippet.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Display a snippet of copyable code for the command line.
1919
/>
2020

2121
<Playground
22-
title="width"
22+
title="Width"
2323
desc="Specify width manually."
2424
scope={{ Snippet }}
2525
code={`
@@ -28,7 +28,7 @@ Display a snippet of copyable code for the command line.
2828
/>
2929

3030
<Playground
31-
title="types"
31+
title="Types"
3232
desc="Show different states with colors."
3333
scope={{ Snippet, Spacer }}
3434
code={`
@@ -55,7 +55,7 @@ Display a snippet of copyable code for the command line.
5555
/>
5656

5757
<Playground
58-
title="without copy"
58+
title="Without copy"
5959
desc="Hide icon for copy. (disable copy)"
6060
scope={{ Snippet }}
6161
code={`
@@ -64,23 +64,23 @@ Display a snippet of copyable code for the command line.
6464
/>
6565

6666
<Playground
67-
title="custom symbol"
67+
title="Custom symbol"
6868
scope={{ Snippet }}
6969
code={`
7070
<Snippet symbol=">" text="yarn add @himalaya-ui/core" w="300px" />
7171
`}
7272
/>
7373

7474
<Playground
75-
title="custom toast"
75+
title="Custom toast"
7676
scope={{ Snippet }}
7777
code={`
7878
<Snippet toastText="Code copied!" toastType="secondary" text="yarn add @himalaya-ui/core" w="300px" />
7979
`}
8080
/>
8181

8282
<Playground
83-
title="filled"
83+
title="Filled"
8484
scope={{ Snippet, Spacer }}
8585
code={`
8686
<>

src/app/components/table/table.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Display tabular data in format.
3333
/>
3434

3535
<Playground
36-
title="compose"
36+
title="Compose"
3737
desc="Show other components in the table."
3838
scope={{ Table, Code, Text }}
3939
code={`
@@ -56,7 +56,7 @@ Display tabular data in format.
5656
/>
5757

5858
<Playground
59-
title="width"
59+
title="Width"
6060
desc="Specifies the `w` of all or part of the columns."
6161
scope={{ Table, Code, Text }}
6262
code={`
@@ -79,7 +79,7 @@ Display tabular data in format.
7979
/>
8080

8181
<Playground
82-
title="actions"
82+
title="Actions"
8383
desc="Custom elements can be displayed in the table, and any changes will be immediately rendered."
8484
scope={{ Table, Text, Button }}
8585
code={`
@@ -110,7 +110,7 @@ Display tabular data in format.
110110
/>
111111

112112
<Playground
113-
title="update row"
113+
title="Update row"
114114
desc="You can use custom elements to update a specific row."
115115
scope={{ Table, Text, Button }}
116116
code={`
@@ -149,7 +149,7 @@ Display tabular data in format.
149149
/>
150150

151151
<Playground
152-
title="custom head"
152+
title="Custom head"
153153
scope={{ Table, Code, Text }}
154154
code={`
155155
() => {

src/app/components/textarea/textarea.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Retrieve multi-line user input.
2020
/>
2121

2222
<Playground
23-
title="disabled"
23+
title="Disabled"
2424
desc="Disable interactive textarea."
2525
scope={{ Textarea }}
2626
code={`
@@ -46,7 +46,7 @@ Retrieve multi-line user input.
4646
/>
4747

4848
<Playground
49-
title="get change"
49+
title="Change event"
5050
desc="Capture changes in textarea."
5151
scope={{ Textarea, useState }}
5252
code={`

src/app/components/toggle/toggle.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Displays a boolean value.
4343
/>
4444

4545
<Playground
46-
title="disabled"
46+
title="Disabled"
4747
scope={{ Toggle, Spacer }}
4848
code={`
4949
<>
@@ -55,7 +55,7 @@ Displays a boolean value.
5555
/>
5656

5757
<Playground
58-
title="get change"
58+
title="Change event"
5959
scope={{ Toggle, Spacer }}
6060
code={`
6161
() => {

0 commit comments

Comments
 (0)