Skip to content

Commit 1b21a33

Browse files
committed
docs: update readme
1 parent 77909ef commit 1b21a33

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ const Component = () => (
118118

119119
| Component | Description |
120120
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
121-
| [`<LayoutProvider>`](#layoutprovider) | A context provider which is only required if you intend on using responsive props or a custom `styles()` instance. |
121+
| [`<LayoutProvider>`](#layoutprovider) | A context provider which is only required if you intend on using responsive props or a custom `styles` instance. |
122122
| [`<Box>`](#box) | A layout component for adding size, padding, position, color, and more using tokens from your CSS variable theme. |
123123
| [`<Cluster>`](#cluster) | A row directional layout component that distributes its items in a cluster. Common use cases are tags and input chips. |
124124
| [`<Column>`](#column) | A layout component that distributes its items in a column without wrapping or shrinking. |
@@ -131,9 +131,9 @@ const Component = () => (
131131

132132
### Hooks
133133

134-
| Component | Description |
135-
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
136-
| [`useResponsiveStyles()`](#useresponsivestyles) | Returns the [responsive `styles()`](https://github.com/dash-ui/responsive) used for creating responsive layout props. |
134+
| Component | Description |
135+
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
136+
| [`useResponsiveStyles()`](#useresponsivestyles) | Returns the [responsive `styles`](https://github.com/dash-ui/responsive) used for creating responsive layout props. |
137137

138138
### TypeScript support
139139

@@ -153,7 +153,7 @@ components.
153153
### &lt;LayoutProvider&gt;
154154

155155
A context provider which is only required if you intend on using media query
156-
props or a custom `styles()` instance.
156+
props or a custom `styles` instance.
157157

158158
#### Example
159159

@@ -191,10 +191,10 @@ const Component = () => (
191191

192192
#### Props
193193

194-
| Prop | Type | Default | Required? | Description |
195-
| ------------ | ------------------------------------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
196-
| styles | `Styles<DashTokens, DashThemeNames>` | `styles` | No | The `styles()` instance you're using to create styles. By default this is the `styles()` instance exported from [`@dash-ui/styles`](https://github.com/dash-ui/styles) |
197-
| mediaQueries | `Record<string, string>` | | No | A mapping of name/media query pairs. This is only required if youre' using responsive props. |
194+
| Prop | Type | Default | Required? | Description |
195+
| ------------ | -------------------------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
196+
| styles | `Styles<DashTokens, DashThemes>` | `styles` | No | The `styles` instance you're using to create styles. By default this is the `styles` instance exported from [`@dash-ui/styles`](https://github.com/dash-ui/styles) |
197+
| mediaQueries | `Record<string, string>` | | No | A mapping of name/media query pairs. This is only required if youre' using responsive props. |
198198

199199
### &lt;Box&gt;
200200

@@ -559,7 +559,7 @@ const Component = () => (
559559

560560
### useResponsiveStyles()
561561

562-
Returns the [responsive `styles()`](https://github.com/dash-ui/responsive)
562+
Returns the [responsive `styles`](https://github.com/dash-ui/responsive)
563563
used for creating responsive layout props.
564564

565565
#### Returns

0 commit comments

Comments
 (0)