Skip to content

Commit

Permalink
fix(docs): fix some typo
Browse files Browse the repository at this point in the history
  • Loading branch information
dpellier committed Sep 4, 2024
1 parent c230f77 commit 21fa967
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 27 deletions.
10 changes: 5 additions & 5 deletions packages/storybook/stories/components/code/code.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,22 @@ export const Demo: StoryObj = {
}),
args: {
canCopy: false,
content: 'import { OsdsText } from \'@ovhcloud/ods-components/react\';'
content: 'import { OdsText } from \'@ovhcloud/ods-components/react\';'
},
};

export const CanCopy: StoryObj = {
tags: ['isHidden'],
render: () => html`
<ods-code can-copy>import { OsdsText } from '@ovhcloud/ods-components/react';
<ods-code can-copy>import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
`,
};

export const CustomCSS: StoryObj = {
tags: ['isHidden'],
render: () => html`
<ods-code class="my-code">import { OsdsText } from '@ovhcloud/ods-components/react';
<ods-code class="my-code">import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
<style>
.my-code {
Expand All @@ -64,15 +64,15 @@ export const Overview: StoryObj = {
layout: 'centered',
},
render: () => html`
<ods-code can-copy>import { OsdsText } from '@ovhcloud/ods-components/react';
<ods-code can-copy>import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
`,
};

export const Default: StoryObj = {
tags: ['isHidden'],
render: () => html`
<ods-code>import { OsdsText } from '@ovhcloud/ods-components/react';
<ods-code>import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
`,
};
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Default usage:
<!-- is now -->

<ods-code>
import { OsdsText } from '@ovhcloud/ods-components/react';
import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
```

Expand All @@ -63,6 +63,6 @@ With a copy button:
<!-- is now -->

<ods-code can-copy>
import { OsdsText } from '@ovhcloud/ods-components/react';
import { OdsText } from '@ovhcloud/ods-components/react';
</ods-code>
```
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Color:

<!-- is now -->

<osds-divider class="custom"></osds-divider>
<ods-divider class="custom"></ods-divider>

<style>
.custom {
Expand All @@ -60,7 +60,7 @@ Contrasted:

<!-- is now -->

<osds-divider color="dark"></osds-divider>
<ods-divider color="dark"></ods-divider>
```

Separator:
Expand All @@ -69,7 +69,7 @@ Separator:

<!-- is now -->

<osds-divider class="custom"></osds-divider>
<ods-divider class="custom"></ods-divider>

<style>
.custom {
Expand All @@ -78,12 +78,11 @@ Separator:
</style>
```


Size:
```html
<osds-divider size="1"></osds-divider>

<!-- is now -->

<osds-divider spacing="2"></osds-divider>
<ods-divider spacing="2"></ods-divider>
```
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,7 @@ Label input:

<!-- is now -->
<ods-form-field>
<ods-text slot='label' color='text'>My label</ods-text>
<label slot='label'>My label</label>
<ods-input type='text' value='Input'></ods-input>
</ods-form-field>
```

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Headline modal:
<!-- is now -->

<ods-modal>
<ods-text preset="heading-3">Hello, world!</ods-text>
<ods-text preset="heading-3">Hello, world!</ods-text>
</ods-modal>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ The same result would now be achieved using:
</ods-quantity>
```


## Attributes changes

`disabled` <ods-badge size="sm" label="Updated"></ods-badge>
Expand Down Expand Up @@ -137,9 +136,11 @@ Has been removed.
The slot plus is now automatically in the component with an ods-button

### Input attributes changes

[Doc input](/docs/ods-components-form-elements-input--migration-from-17-x)

### Button attributes changes

[Doc button](/docs/ods-components-button--migration-from-17-x)

## Migration examples
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,5 +130,4 @@ Group radio:
<ods-radio value="A" name="group-radio"></ods-radio>
<ods-radio value="B" name="group-radio"></ods-radio>
<ods-radio value="C" name="group-radio"></ods-radio>

```
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,3 @@ Required select:
<option value="de">Germany</option>
</ods-select>
```

Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Id switch:

<!-- is now -->

<osds-switch-item input-id="id-1" value="1">Value 1</osds-switch-item>
<ods-switch-item input-id="id-1" value="1">Value 1</ods-switch-item>
```

Checked switch:
Expand All @@ -64,9 +64,9 @@ Checked switch:
<!-- is now -->

<ods-switch name="checked-group">
<osds-switch-item is-checked value="1">Value 1</osds-switch-item>
<osds-switch-item value="2">Value 2</osds-switch-item>
<osds-switch-item value="3">Value 3</osds-switch-item>
<ods-switch-item is-checked value="1">Value 1</ods-switch-item>
<ods-switch-item value="2">Value 2</ods-switch-item>
<ods-switch-item value="3">Value 3</ods-switch-item>
</ods-switch>
```

Expand All @@ -81,8 +81,8 @@ Disabled switch:
<!-- is now -->

<ods-switch is-disabled name="disabled-group">
<osds-switch-item value="1">Value 1</osds-switch-item>
<osds-switch-item value="2">Value 2</osds-switch-item>
<osds-switch-item value="3">Value 3</osds-switch-item>
<ods-switch-item value="1">Value 1</ods-switch-item>
<ods-switch-item value="2">Value 2</ods-switch-item>
<ods-switch-item value="3">Value 3</ods-switch-item>
</ods-switch>
```
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ You can use the new `preset` attribute to obtain the same rendering.
## Migration examples

Size & Level text:

```html
<osds-text size="500" level="heading">My text</osds-text>

Expand All @@ -34,6 +35,7 @@ Size & Level text:
```

Color text:

```html
<osds-text color="primary">My text</osds-text>

Expand All @@ -49,6 +51,7 @@ Color text:
```

breakSpaces text:

```html
<osds-text break-spaces>My text</osds-text>

Expand All @@ -62,4 +65,3 @@ breakSpaces text:
}
</style>
```

Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,3 @@ Arrow tooltip:
Tooltip content
</ods-tooltip>
```

0 comments on commit 21fa967

Please sign in to comment.