mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
docs(text-input): improve docs
This commit is contained in:
parent
874bf43378
commit
e86875b8ed
1 changed files with 28 additions and 0 deletions
|
@ -7,54 +7,82 @@ components: ["TextInput", "TextInputSkeleton"]
|
||||||
import Preview from "../../components/Preview.svelte";
|
import Preview from "../../components/Preview.svelte";
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
`TextInput` provides a single-line text input field with support for various states, sizes, and accessibility features. It's ideal for short text input like usernames, search terms, or form fields.
|
||||||
|
|
||||||
## Default
|
## Default
|
||||||
|
|
||||||
|
Create a basic text input with a label and placeholder text.
|
||||||
|
|
||||||
<TextInput labelText="User name" placeholder="Enter user name..." />
|
<TextInput labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## With helper text
|
## With helper text
|
||||||
|
|
||||||
|
Add helper text below the input to provide additional context or instructions.
|
||||||
|
|
||||||
<TextInput labelText="User name" helperText="Your user name is associated with your email" placeholder="Enter user name..." />
|
<TextInput labelText="User name" helperText="Your user name is associated with your email" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Hidden label
|
## Hidden label
|
||||||
|
|
||||||
|
Visually hide the label while maintaining accessibility by setting `hideLabel` to `true`.
|
||||||
|
|
||||||
<TextInput hideLabel labelText="User name" placeholder="Enter user name..." />
|
<TextInput hideLabel labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Light variant
|
## Light variant
|
||||||
|
|
||||||
|
Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
||||||
|
|
||||||
<TextInput light labelText="User name" placeholder="Enter user name..." />
|
<TextInput light labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Inline variant
|
## Inline variant
|
||||||
|
|
||||||
|
Use the inline variant to display the label and input on the same line by setting `inline` to `true`.
|
||||||
|
|
||||||
<TextInput inline labelText="User name" placeholder="Enter user name..." />
|
<TextInput inline labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Read-only variant
|
## Read-only variant
|
||||||
|
|
||||||
|
Display a non-editable value by setting `readonly` to `true`.
|
||||||
|
|
||||||
<TextInput readonly labelText="User name" value="IBM" />
|
<TextInput readonly labelText="User name" value="IBM" />
|
||||||
|
|
||||||
## Extra-large size
|
## Extra-large size
|
||||||
|
|
||||||
|
Use the extra-large size for more prominent inputs by setting `size` to `"xl"`.
|
||||||
|
|
||||||
<TextInput size="xl" labelText="User name" placeholder="Enter user name..." />
|
<TextInput size="xl" labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Small size
|
## Small size
|
||||||
|
|
||||||
|
Use the small size for more compact inputs by setting `size` to `"sm"`.
|
||||||
|
|
||||||
<TextInput size="sm" labelText="User name" placeholder="Enter user name..." />
|
<TextInput size="sm" labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Invalid state
|
## Invalid state
|
||||||
|
|
||||||
|
Indicate an invalid state with an error message by setting `invalid` to `true` and providing `invalidText`.
|
||||||
|
|
||||||
<TextInput invalid invalidText="User name is already taken. Please try another." labelText="User name" placeholder="Enter user name..." />
|
<TextInput invalid invalidText="User name is already taken. Please try another." labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Warning state
|
## Warning state
|
||||||
|
|
||||||
|
Indicate a warning state with a message by setting `warn` to `true` and providing `warnText`.
|
||||||
|
|
||||||
<TextInput warn warnText="Your user name is different from your log in ID." labelText="User name" placeholder="Enter user name..." />
|
<TextInput warn warnText="Your user name is different from your log in ID." labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Disabled state
|
## Disabled state
|
||||||
|
|
||||||
|
Disable the input to prevent user interaction by setting `disabled` to `true`.
|
||||||
|
|
||||||
<TextInput disabled labelText="User name" placeholder="Enter user name..." />
|
<TextInput disabled labelText="User name" placeholder="Enter user name..." />
|
||||||
|
|
||||||
## Skeleton
|
## Skeleton
|
||||||
|
|
||||||
|
Show a loading state with the default skeleton variant.
|
||||||
|
|
||||||
<TextInputSkeleton />
|
<TextInputSkeleton />
|
||||||
|
|
||||||
## Skeleton without label
|
## Skeleton without label
|
||||||
|
|
||||||
|
Show a loading state without a label by setting `hideLabel` to `true`.
|
||||||
|
|
||||||
<TextInputSkeleton hideLabel />
|
<TextInputSkeleton hideLabel />
|
Loading…
Add table
Add a link
Reference in a new issue