Skip to content

Commit 5f33510

Browse files
committed
Fix prop names in ColorInput docs
1 parent 8a7ed68 commit 5f33510

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

packages/circuit-ui/components/ColorInput/ColorInput.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,29 @@ import * as Stories from './ColorInput.stories';
55

66
# ColorInput
77

8-
## Use cases and API
98
<Status variant="stable" />
109

1110
The ColorInput component enables users to type a color in a text field or select it using the browser native color picker.
1211

13-
Use the ColorInput component to allow users to input a color value to personalize content such as UI themes, profile settings or other customizable experiences.
12+
<Story of={Stories.Base} />
13+
<Props />
1414

15+
## Usage
16+
17+
Use the ColorInput component to allow users to input a color value to personalize content such as UI themes, profile settings or other customizable experiences.
1518

1619
The component only supports seven-character string representations of colors in hexadecimal format. Shorthand Hex values like `#fff` will not be normalized to `#ffffff` and values with alpha channel like `##ffffff50` will not be accepted.
20+
1721
- Accepted: `#aabbcc`, `#AABBCC`
1822
- Not accepted: `#abc`, `#aabbccaa`, `#ABC`, `#AABBCCAA`
1923

20-
<Story of={Stories.Base} />
21-
22-
<Props />
23-
2424
## Validations
2525

2626
Use the `validationHint` prop to communication information about the state of the ColorInput component, along with one of the following validation props:
27+
2728
- stand-alone: The user is informed of the expected response.
28-
- `showWarning`: The user is warned that the value is not recommended but still valid.
29-
- `showError`: The user is alerted that the value is invalid.
29+
- `invalid`: The user is alerted that the value is invalid.
30+
- `hasWarning`: The user is warned that the value is not recommended but still valid.
3031
- `showValid`: The user is reassured that the value is valid. Use sparingly.
3132

3233
<Story of={Stories.Validations} />
@@ -47,4 +48,5 @@ The read-only state is applied to the text input field of the ColorInput compone
4748
## Disabled
4849

4950
Disabled form fields can be confusing to users, so use them with caution. Use a disabled color input only if you need to communicate to the user that an option that existed before is not available for choosing now. Consider not displaying the field at all or add an explanation why the field is disabled.
51+
5052
<Story of={Stories.Disabled} />

0 commit comments

Comments
 (0)