Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Commit 3fd1e67

Browse files
committed
docs: correct minor grammar and insensitive writing
1 parent 157312f commit 3fd1e67

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+189
-189
lines changed

website/pages/accessibility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ heavy-lifting for you in order to allow you to focus on building your applicatio
55

66
All authored components are compliant with the WAI-ARIA standards for authored components.
77

8-
We've taken the time to write summarized description of the accessibility support for
8+
We've taken the time to write a summarized description of the accessibility support for
99
all authored components in @chakra-ui/vue. We called this document an accessibility report
1010
and can be found in the `accessibility.md` file in the respective component's source directory.
1111

website/pages/accordion.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import {
3535

3636
## Usage
3737

38-
By default, only one accordion item may be expanded. It can only be collapsed again by expanding another accordion item.
38+
By default, only one accordion-item may be expanded. It can only be collapsed again by expanding another accordion item.
3939

4040
```vue live=true
4141
<c-accordion>
@@ -203,7 +203,7 @@ In the example below, we change the icon rendered by the `CAccordionIcon` based
203203
```
204204

205205
### Accessibility
206-
Pressing **`space`** or **`enter`** when focus is on the `CAccordionHeader` will toggle (expand or collapse) the accordion item.
206+
Pressing **`space`** or **`enter`** when the focus is on the `CAccordionHeader` will toggle (expand or collapse) the accordion item.
207207

208208
# Props
209209
## `CAccordion`
@@ -212,7 +212,7 @@ Pressing **`space`** or **`enter`** when focus is on the `CAccordionHeader` will
212212
| ------------- | --------------------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
213213
| allowMultiple | `boolean` | `false` | If `true`, multiple accordion items can be expanded at once. |
214214
| allowToggle | `boolean` | `false` | If `true`, any expanded accordion item can be collapsed again. |
215-
| index | `Number` or `Array of Number` | 0 | The index(es) of the expanded accordion item |
215+
| index | `Number` or `Array of Number` | 0 | The index(es) of the expanded accordion-item |
216216
| defaultIndex | `Number` or `Array of Number` | | The initial index(es) of the expanded accordion item |
217217

218218
### Events
@@ -254,7 +254,7 @@ Pressing **`space`** or **`enter`** when focus is on the `CAccordionHeader` will
254254

255255
### Props
256256
`CAccordionHeader` renders a `button` and composes `CPseudoBox`, this means you can
257-
style it by passing the pseudo style props `_expanded`, `_disabled`, `_hover`,
257+
style it bypassing the pseudo style props `_expanded`, `_disabled`, `_hover`,
258258
etc.
259259

260260
## `CAccordionPanel`

website/pages/alert.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ import SEO from '../components/SEO'
22

33
<SEO
44
title="Alert"
5-
description="Alerts are used to communicate a state that affects a system, feature or page."
5+
description="Alerts are used to communicate a state that affects a system, feature, or page."
66
/>
77

88
# Alert
99

10-
Alerts are used to communicate a state that affects a system, feature or page.
10+
Alerts are used to communicate a state that affects a system, feature, or page.
1111

1212
See `CAlert`'s <a href="https://github.com/chakra-ui/chakra-ui-vue/blob/master/packages/chakra-ui-core/src/CAlert/accessibility.md">accessibility report</a>
1313

1414
## Import
1515

16-
Chakra UI Vue exports 4 Alert related components.
16+
Chakra UI Vue exports four Alert-related components.
1717

1818
- `CAlert`: The wrapper for alert components.
1919
- `CAlertIcon`: The visual icon for the alert that changes based on the `status` prop.
@@ -87,7 +87,7 @@ You can also use custom Alert icons by passing the name of the icon in the `name
8787

8888
### Variant
8989

90-
The `CAlert` component has 4 variant styles you can use. Pass the `variant` prop and use either
90+
The `CAlert` component has four variant styles you can use. Pass the `variant` prop and use either
9191
`subtle`, `solid`, `left-accent` or `top-accent`.
9292

9393
```vue live=true
@@ -113,8 +113,8 @@ The `CAlert` component has 4 variant styles you can use. Pass the `variant` prop
113113

114114
### Composition
115115

116-
`CAlert` ships with other smaller components to allow for flexibility and make it easy to
117-
create all kinds of layout. Here's an example of a custom alert style and layout.
116+
`CAlert` ships with other smaller components to allow for flexibility and make it possible to
117+
create all kinds of layouts. Here's an example of a custom alert style and layout.
118118

119119
```vue live=true
120120
<c-alert

website/pages/alertdialog.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See `CAlertDialog`'s <a href="https://github.com/chakra-ui/chakra-ui-vue/blob/ma
1414

1515
## Import
1616

17-
Chakra UI exports 7 alert dialog related components.
17+
Chakra UI exports seven alert dialog-related components.
1818

1919
- `CAlertDialog`: provides context and state for the dialog.
2020
- `CAlertDialogHeader`: should contain the title announced by screen readers.
@@ -45,7 +45,7 @@ Vue ref to a focusable element or component in your alert dialog. The `leastDest
4545
a function that returns a ref.
4646

4747
Based on [WAI-ARIA specifications for alert dialogs](https://www.w3.org/TR/wai-aria-practices/#alertdialog)
48-
when the dialog opens, focus should be placed on the least destructive element
48+
when the dialog opens, the focus should be placed on the least destructive element
4949
to prevent users from accidentally confirming the destructive action.
5050

5151
```vue live=true
@@ -101,18 +101,18 @@ export default {
101101
## Accessibility
102102

103103
- `CAlertDialog` has role `alertdialog`, and `aria-modal` set to true.
104-
- When the dialog opens, focus is automatically set to the least destructive
104+
- When the dialog opens, the focus is automatically set to the least destructive
105105
element.
106106
- When the dialog opens, the content in the `CAlertDialogHeader` and
107-
`CAlertDialogBody` are announced by screen readers via `aria-labelledby` and
107+
`CAlertDialogBody` is announced by screen readers via `aria-labelledby` and
108108
`aria-describedby` attributes.
109109
- Clicking on the overlay closes the `CAlertDialog`.
110110
- Pressing <kbd>esc</kbd> closes the dialog.
111111

112112

113113
## Props
114114

115-
AlertDialog and it's components composes the `CModal` component, the only
115+
AlertDialog and its components composes the `CModal` component, the only
116116
exception is that it requires a `leastDestructiveRef` which is similar to the
117117
`initialFocusRef` in `CModal`
118118

website/pages/auto-import-components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import SEO from '../components/SEO'
99
We know that it can be cumbersome to import every single Chakra component you want to use in your Vue templates. Chakra UI offers webpack plugin solution that allows
1010
you to directly consume Chakra UI Vue components without manually importing and globally registering all Chakra components.
1111

12-
This provides a better developer experience without sacrificing your applications bundle-size performance.
12+
This provides a better developer experience without sacrificing your application's bundle-size performance.
1313

1414

1515
## Installation
@@ -103,7 +103,7 @@ export default {
103103

104104

105105
## How it works
106-
`ChakraLoaderPlugin` will analyse your SFC template at during development and at build time, and scan it for all Chakra UI Vue components that you consume in it. The loader will then proceed to automatically import those components and register them while preserving treeshaking.
106+
`ChakraLoaderPlugin` will analyse your SFC template during development and at build time, and scan it for all Chakra UI Vue components that you consume in it. The loader will then proceed to automatically import those components and register them while preserving treeshaking.
107107

108108
For example, consider the component below, `Component.vue` which uses Chakra's `CBox` and `CButton` components.
109109
```vue

website/pages/avatar.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `CAvatar` component is used to visually represent a user by displaying their
1111

1212
## Import
1313

14-
Chakra UI Vue exports 3 Avatar related components.
14+
Chakra UI Vue exports three Avatar-related components.
1515

1616
- `CAvatar`: The image that represents the user.
1717
- `CAvatarBadge`: A widget that displays the status of a user on the bottom-right corner of the `CAvatar`.
@@ -129,7 +129,7 @@ component to do this
129129
| size | `2xs`, `xs`, `sm`, `md`, `lg`, `xl`, `2xl` | `md` | The size of the avatar |
130130
| showBorder | `boolean` | `false` | If `true`, the `CAvatar` will show a border around it. Best for a group of avatars |
131131
| name | `string` | | The name of the user in the avatar |
132-
| src | `string` | | The image url of the `CAvatar` |
132+
| src | `string` | | The image URL of the `CAvatar` |
133133

134134
> - `CAvatar` composes the `CBox` component. So it also accepts
135135
> all `CBox` props.

website/pages/badge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ object.
4040

4141
### Badge Variants
4242

43-
Pass the `variant` prop and set to either `subtle`, `solid`, or `outline` to get a
43+
Pass the `variant` prop and set it to either `subtle`, `solid`, or `outline` to get a
4444
different style.
4545

4646
```vue live=true
@@ -68,7 +68,7 @@ different style.
6868

6969
<br />
7070

71-
You can also change the size of the badge by passing `fontSize` prop.
71+
You can also change the size of the badge bypassing `fontSize` prop.
7272

7373
```vue live=true
7474
<c-text font-weight="bold">

website/pages/box.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import SEO from '../components/SEO'
1212

1313
<br />
1414

15-
**The `CBox` component is useful because it helps with 3 common use cases:**
15+
**The `CBox` component is useful because it helps with three common use cases:**
1616
- Creation of responsive layouts with ease.
1717
- Provides a shorthand way to pass styles via props (`bg` instead of `backgroundColor`).
1818
- Composition of new components by providing for overrides by using the `as` prop.
@@ -106,7 +106,7 @@ import { CBox } from '@chakra-ui/vue';
106106

107107
### `as` prop
108108

109-
You can use the `as` prop to change the element render, just like the `tag` prop on Vue's global dynamic component.
109+
You can use the `as` prop to change the element render, like the `tag` prop on Vue's global dynamic component.
110110

111111
```vue live=true
112112
<c-box as="button" rounded="md" bg="tomato" color="white" px="4" h="8">

website/pages/breadcrumb.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ import SEO from '../components/SEO'
22

33
<SEO
44
title="Breadcrumb"
5-
description="Breadcrumbs, or a breadcrumb navigation, can help to enhance how users navigate to previous page levels of a website, especially if that website has many pages or products."
5+
description="Breadcrumbs, or breadcrumb navigation, can help to enhance how users navigate to previous page levels of a website, especially if that website has many pages or products."
66
/>
77

88

99
# Breadcrumb
1010

11-
Breadcrumbs, or a breadcrumb navigation, can help to enhance how users navigate
11+
Breadcrumbs, or breadcrumb navigation, can help to enhance how users navigate
1212
to previous page levels of a website, especially if that website has many pages
1313
or products.
1414

@@ -17,11 +17,11 @@ or products.
1717
See `CBreadcrumb`'s [accessibility report](https://github.com/chakra-ui/chakra-ui-vue/blob/master/packages/chakra-ui-core/src/CBreadcrumb/accessibility.md)
1818

1919
## Import
20-
Chakra UI exports 4 Breadcrumb related components:
20+
Chakra UI exports four Breadcrumb related components:
2121

2222
- `CBreadcrumb`: The parent container for breadcrumbs.
2323
- `CBreadcrumbItem`: Individual breadcrumb element containing a link and a divider.
24-
- `CBreadcrumbLink`: The breadcrumb link, obviously.
24+
- `CBreadcrumbLink`: The breadcrumb link.
2525
- `CBreadcrumbSeparator`: The visual separator between each breadcrumb
2626

2727
<br />
@@ -84,7 +84,7 @@ on the `CBreadcrumb` to `false`, and manually add the `CBreadcrumbSeparator` as
8484
`CBreadcrumbItem`.
8585

8686
You can then pass style props to change the styling of the `CBreadcrumbSeparator`. You can also override
87-
the content of the `CBreadcrumbSeparator` by passing its default slot.
87+
the content of the `CBreadcrumbSeparator` bypassing its default slot.
8888

8989
```vue live=true
9090
<c-breadcrumb :add-separator="false">
@@ -131,7 +131,7 @@ breadcrumbs.
131131
To use the `CBreadcrumb` with a routing Library like [Vue Router](https://router.vuejs.org),
132132
all you need to do is to pass the `as` prop to the `CBreadcrumbLink` component.
133133

134-
It'll replace the rendered `a` tag with with `router-link` or `nuxt-link`.
134+
It will replace the rendered `a` tag with `router-link` or `nuxt-link`.
135135

136136
```vue live=true
137137
<c-breadcrumb separator="›">
@@ -152,7 +152,7 @@ It'll replace the rendered `a` tag with with `router-link` or `nuxt-link`.
152152
- The `CBreadcrumb` `nav` has `aria-label` set to `breadcrumb`.
153153
- The `CBreadcrumbItem` with `isCurrentPage` prop adds the `aria-current=page` to
154154
the `CBreadcrumbLink`.
155-
- The separator has `role` set to `presentation` to denote that its for
155+
- The separator has `role` set to `presentation` to denote that it's for
156156
presentation purposes.
157157

158158

website/pages/button.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ You can add left and right icons to the Button component. See how to [add icons]
8585

8686
### Button loading state
8787

88-
Pass `isLoading` prop to the Button component to show it's loading state. You can optionally pass `loadingText` prop, if you do, the button will show a spinner and the loading text. Otherwise, the button will take the width of the text label and show only the spinner.
88+
Pass `isLoading` prop to the Button component to show its loading state. You can optionally pass `loadingText` prop, if you do, the button will show a spinner and the loading text. Otherwise, the button will take the width of the text label and show only the spinner.
8989

9090
```vue live=true
9191
<c-button-group :spacing="4">
@@ -106,7 +106,7 @@ Pass `isLoading` prop to the Button component to show it's loading state. You ca
106106
### Accessibility
107107

108108
- `CButton` has `role` button.
109-
- When `CButton` has focus, `space` and `enter` activates it.
109+
- When `CButton` has focus, `space` and `enter` activate it.
110110

111111
### Composition
112112

@@ -123,7 +123,7 @@ Pass `isLoading` prop to the Button component to show it's loading state. You ca
123123

124124
### Custom Button
125125

126-
In event you need to make your own custom button, you can leverage the `PseudoBox` component. It provides the `hover`, `focus`, `active` and `disabled` style props to style the button.
126+
In the event you need to make your own custom button, you can leverage the `PseudoBox` component. It provides the `hover`, `focus`, `active` and `disabled` style props to style the button.
127127

128128
```vue live=true
129129
<c-pseudo-box
@@ -147,7 +147,7 @@ In event you need to make your own custom button, you can leverage the `PseudoBo
147147

148148
## Props
149149

150-
The Button composes the `CPseudoBox` component so you can pass props for `CPseudoBox`. These are props related to the Button component.
150+
The button composes the `CPseudoBox` component so you can pass props for `CPseudoBox`. These are props related to the Button component.
151151

152152
| Name | Type | Default | Description |
153153
| --------------------- | ------------------------------------------------| --------| ------------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)