Skip to content

Commit

Permalink
update code blocks and fix spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdholt committed May 29, 2020
1 parent 33879d2 commit 497031d
Show file tree
Hide file tree
Showing 12 changed files with 63 additions and 63 deletions.
16 changes: 8 additions & 8 deletions packages/web-components/fast-foundation/src/checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ export class FASTCheckbox extends Checkbox {}

## Usage
```html
<fieldset>
<legend>Fruits</legend>
<fast-checkbox checked>Apple</fast-checkbox>
<fast-checkbox checked>Banana</fast-checkbox>
<fast-checkbox>Honeydew</fast-checkbox>
<fast-checkbox checked>Mango</fast-checkbox>
</fieldset>
```
<fieldset>
<legend>Fruits</legend>
<fast-checkbox checked>Apple</fast-checkbox>
<fast-checkbox checked>Banana</fast-checkbox>
<fast-checkbox>Honeydew</fast-checkbox>
<fast-checkbox checked>Mango</fast-checkbox>
</fieldset>
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: fast-dialog
sidebar_label: fast-dialog
custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/dialog/README.md
---
A web component implementation of a [dialog](https://w3c.github.io/aria-practices/#dialog_modal) which can either be modal or non-modal. The modal
A web component implementation of a [dialog](https://w3c.github.io/aria-practices/#dialog_modal) which can either be modal or non-modal.

## Applying Custom Styles

Expand Down
4 changes: 2 additions & 2 deletions packages/web-components/fast-foundation/src/flipper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: fast-flipper
custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/flipper/README.md
---

The flipper component is most often used to page through blocks of content or collections of ui elements. As flippers are often a supplemental form of navigation, the flippers are hidden by default to avoid duplicate keyboard interaction. Passing an attribute of `aria-hidden="false` will expose the flippers to assistive technology.
The flipper component is most often used to page through blocks of content or collections of ui elements. As flippers are often a supplemental form of navigation, the flippers are hidden by default to avoid duplicate keyboard interaction. Passing an attribute of `aria-hidden="false"` will expose the flippers to assistive technology.

## Applying Custom Styles

Expand All @@ -24,5 +24,5 @@ export class FASTFlipper extends Flipper {}

## Usage
```html
<fast-flipper direction="previous"></fast-flipper>
<fast-flipper direction="previous"></fast-flipper>
```
26 changes: 13 additions & 13 deletions packages/web-components/fast-foundation/src/menu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ export class FASTMenu extends Menu {}

## Usage
```html
<fast-menu>
<fast-menu-item>Menu item 1</fast-menu-item>
<fast-menu-item>Menu item 2</fast-menu-item>
<fast-menu-item>Menu item 3</fast-menu-item>
<fast-divider></fast-divider>
<fast-menu-item role="menuitemradio">Menu item 4</fast-menu-item>
<fast-menu-item role="menuitemradio">Menu item 5</fast-menu-item>
</fast-menu>
<fast-menu>
<fast-menu-item>Menu item 1</fast-menu-item>
<fast-menu-item>Menu item 2</fast-menu-item>
<fast-menu-item>Menu item 3</fast-menu-item>
<fast-divider></fast-divider>
<fast-menu-item role="menuitemradio">Menu item 4</fast-menu-item>
<fast-menu-item role="menuitemradio">Menu item 5</fast-menu-item>
</fast-menu>
```

__Custom menu items__
```html
<fast-menu>
<div role="menuitem">Menu item 1</div>
<div role="menuitem">Menu item 2</div>
<div role="menuitem">Menu item 3</div>
</fast-menu>
<fast-menu>
<div role="menuitem">Menu item 1</div>
<div role="menuitem">Menu item 2</div>
<div role="menuitem">Menu item 3</div>
</fast-menu>
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: fast-progress
sidebar_label: fast-progress
custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/progress/README.md
---
Progress components are used to display the length of time a process will take or to visualize percentage value (referred to as a **determinate** state) and to represent an unspecified wait time (referred to as an **indeterminate** state). For progress components which have a linear visual appearance, use `fast-progress`. For progress implementations which are circular, use `fast-progress-ring`.
Progress components are used to indicate the length of time a process will take. This may either be as a determinate state in which the progress is a percentage of the total time needed to complete the task, or as an indeterminate state where the wait time is unspecified. For progress components which have a linear visual appearance, use `fast-progress`. For progress implementations which are circular, use `fast-progress-ring`.

## Applying Custom Styles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ export class FASTRadioGroup extends RadioGroup {}
## Usage

```html
<label id="radiogroup">Preset selected-value</label>
<fast-radio-group value="maverick" aria-labelledby="radiogroup" name="best-pilot">
<fast-radio value="ice-man">Ice Man</fast-radio>
<fast-radio value="maverick">Maverick</fast-radio>
<fast-radio value="viper">Viper</fast-radio>
<fast-radio value="jester">Jester</fast-radio>
</fast-radio-group>
<label id="radiogroup">Preset selected-value</label>
<fast-radio-group value="maverick" aria-labelledby="radiogroup" name="best-pilot">
<fast-radio value="ice-man">Ice Man</fast-radio>
<fast-radio value="maverick">Maverick</fast-radio>
<fast-radio value="viper">Viper</fast-radio>
<fast-radio value="jester">Jester</fast-radio>
</fast-radio-group>
```
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ export class FASTRadio extends Radio {}
## Usage

```html
<fast-radio value="mango" required>Mango</fast-radio>
<fast-radio value="mango" required>Mango</fast-radio>
```
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ export class FASTSliderLabel extends SliderLabel {}
## Usage

```html
<fast-slider-label>Fast</fast-slider-label>
<fast-slider-label>Fast</fast-slider-label>
```
44 changes: 22 additions & 22 deletions packages/web-components/fast-foundation/src/slider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,26 @@ export class FASTSlider extends Slider {}
## Usage

```html
<fast-slider min="0" max="100" step="10" value="70">
<fast-slider-label
position="0"
>
0
</fast-slider-label>
<fast-slider-label
position="10"
>
10
</fast-slider-label>
<fast-slider-label
position="90"
>
90
</fast-slider-label>
<fast-slider-label
position="100"
>
100
</fast-slider-label>
</fast-slider>
<fast-slider min="0" max="100" step="10" value="70">
<fast-slider-label
position="0"
>
0
</fast-slider-label>
<fast-slider-label
position="10"
>
10
</fast-slider-label>
<fast-slider-label
position="90"
>
90
</fast-slider-label>
<fast-slider-label
position="100"
>
100
</fast-slider-label>
</fast-slider>
```
10 changes: 5 additions & 5 deletions packages/web-components/fast-foundation/src/switch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ export class FASTSwitch extends Switch {}
## Usage

```html
<fast-switch>
Theme
<span slot="checked-message">Dark</span>
<span slot="unchecked-message">Light</span>
</fast-switch>
<fast-switch>
Theme
<span slot="checked-message">Dark</span>
<span slot="unchecked-message">Light</span>
</fast-switch>
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: fast-text-area
custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/text-area/README.md
---

An implementation of an [HTML textarea element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) as a form-connected web-component. The `fast-text-area` supports two visual apperances, outline and filled, with the control defaulting to the outline appearance.
An implementation of an [HTML textarea element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) as a form-connected web-component. The `fast-text-area` supports two visual appearances, outline and filled, with the control defaulting to the outline appearance.

## Applying Custom Styles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: fast-text-field
custom_edit_url: https://github.com/microsoft/fast-dna/edit/master/packages/web-components/fast-foundation/src/text-field/README.md
---

An implementation of a [text field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input/text) as a form-connected web-component. The `fast-text-field` supports two visual apperances, outline and filled, with the control defaulting to the outline appearance.
An implementation of a [text field](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input/text) as a form-connected web-component. The `fast-text-field` supports two visual appearances, outline and filled, with the control defaulting to the outline appearance.

## Applying Custom Styles

Expand Down

0 comments on commit 497031d

Please sign in to comment.