Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 25, 2020
1 parent 54af2ac commit a85bd6f
Show file tree
Hide file tree
Showing 24 changed files with 281 additions and 402 deletions.
34 changes: 14 additions & 20 deletions components/govukwc-accordion/README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,41 @@
# Accordion
# gov-uk-accordion

See: https://design-system.service.gov.uk/components/accordion/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/accordion/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/accordion/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-accordion.component.js';
```

**Markup**

```markup
<govukwc-accordion></govukwc-accordion>
```
## API

## &lt;govukwc-accordion&gt;
## `<govukwc-accordion>`

### Properties

| Property | Type |
|-----------|-----------|
| `id` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| id|string|""|A unique id to describe the accordion|

### Slots

| Name | Description |
|-----------|-----------|
| `Default` | `Accepts x number of govuk-accordion-section elements` |
| `default` | `Accepts x number of <govuk-accordion-section> elements` |

## &lt;govukwc-accordion-section&gt;
## `<govukwc-accordion-section>`

### Properties

| Property | Type |
|-----------|-----------|
| `heading` | `string` |
| `body` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| heading|string|""|Heading / toggle text|

### Slots

| Name | Description |
|-----------|-----------|
| `Default` | `Accordion body content` |
| `default` | `Accordion body content` |

23 changes: 9 additions & 14 deletions components/govukwc-back-link/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,22 @@
# Back Link
# gov-uk-back-link

See: https://design-system.service.gov.uk/components/back-link/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/back-link/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/back-link/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-back-link.component.js';
```

**Markup**

```markup
<govukwc-back-link></govukwc-back-link>
```
## API

## &lt;govukwc-back-link&gt;
## `<govukwc-back-link>`

### Properties

| Property | Type |
|-----------|-----------|
| `url` | `string` |
| `label` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| url|string|""|""
| label|string|""|""|

31 changes: 13 additions & 18 deletions components/govukwc-breadcrumbs/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,30 @@
# Breadcrumbs
# gov-uk-breadcrumbs

See: https://design-system.service.gov.uk/components/breadcrumbs/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/breadcrumbs/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/breadcrumbs/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-breadcrumbs.component.js';
```

**Markup**

```markup
<govukwc-breadcrumbs></govukwc-breadcrumbs>
```
## API

## &lt;govukwc-breadcrumbs&gt;
## `<govukwc-breadcrumbs>`

### Properties

| Property | Type |
|-----------|-----------|
| `items` | `array` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| items|array|""|""|

## &lt;govukwc-breadcrumbs-item&gt;
## `<govukwc-breadcrumbs-item>`

### Properties

| Property | Type |
|-----------|-----------|
| `url` | `string` |
| `label` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| url|string|""|""
| label|string|""|""|

29 changes: 12 additions & 17 deletions components/govukwc-button/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,27 @@
# Button
# gov-uk-button

See: https://design-system.service.gov.uk/components/button/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/button/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/button/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-button.component.js';
```

**Markup**

```markup
<govukwc-button></govukwc-button>
```
## API

## &lt;govukwc-button&gt;
## `<govukwc-button>`

### Properties

| Property | Type |
|-----------|-----------|
| `label` | `string` |
| `url` | `string` |
| `type` | `"start" \|"secondary"\|"warning"` |
| `disabled` | `boolean` |
| `preventDoubleClick` | `boolean` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| label|string|""|""
| url|string|""|If url is set the ement is rendered as an anchor element
| type|"start" \|"secondary"\|"warning"|""|""
| disabled|boolean|""|""
| preventDoubleClick|boolean|""|""|

### Events

Expand Down
41 changes: 18 additions & 23 deletions components/govukwc-character-count/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,31 @@
# Character Count
# gov-uk-character-count

See: https://design-system.service.gov.uk/components/character-count/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/character-count/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/character-count/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-character-count.component.js';
```

**Markup**

```markup
<govukwc-character-count></govukwc-character-count>
```
## API

## &lt;govukwc-character-count&gt;
## `<govukwc-character-count>`

### Properties

| Property | Type |
|-----------|-----------|
| `maxwords` | `number` |
| `maxlength` | `number` |
| `rows` | `number` |
| `id` | `string` |
| `name` | `string` |
| `label` | `string` |
| `hint` | `string` |
| `error` | `string` |
| `message` | `string` |
| `pageLevel` | `boolean` |
| `invalid` | `boolean` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| maxwords|number|""|""
| maxlength|number|200|""
| rows|number|5|""
| id|string|""|""
| name|string|""|""
| label|string|""|""
| hint|string|""|""
| error|string|""|""
| message|string|""|""
| pageLevel|boolean|""|""
| invalid|boolean|""|""|

37 changes: 16 additions & 21 deletions components/govukwc-checkboxes/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,33 @@
# Checkboxes
# gov-uk-checkboxes

See: https://design-system.service.gov.uk/components/checkboxes/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/checkboxes/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/checkboxes/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-checkboxes.component.js';
```

**Markup**

```markup
<govukwc-checkboxes></govukwc-checkboxes>
```
## API

## &lt;govukwc-checkboxes&gt;
## `<govukwc-checkboxes>`

### Properties

| Property | Type |
|-----------|-----------|
| `legend` | `string` |
| `hint` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| legend|string|""|""
| hint|string|""|""|

## &lt;govukwc-checkbox&gt;
## `<govukwc-checkbox>`

### Properties

| Property | Type |
|-----------|-----------|
| `id` | `string` |
| `name` | `string` |
| `label` | `string` |
| `value` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| id|string|""|""
| name|string|""|""
| label|string|""|""
| value|string|""|""|

15 changes: 5 additions & 10 deletions components/govukwc-date-input/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
# Date Input
# gov-uk-date-input

See: https://design-system.service.gov.uk/components/date-input/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/date-input/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/date-input/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-date-input.component.js';
```

**Markup**

```markup
<govukwc-date-input></govukwc-date-input>
```
## API

## &lt;govukwc-date-input&gt;
## `<govukwc-date-input>`

21 changes: 8 additions & 13 deletions components/govukwc-details/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,23 @@
# Details
# gov-uk-details

See: https://design-system.service.gov.uk/components/details/
- [Reference docs at GOV.UK](https://design-system.service.gov.uk/components/details/)
- [Storybook demo and code samples](http://tgreyuk.github.io/govuk-webcomponents/storybook/?path=/story/details/)

## Usage

**Js**

```javascript
import 'govukwc-webcomponents/components/govukwc-details.component.js';
```

**Markup**

```markup
<govukwc-details></govukwc-details>
```
## API

## &lt;govukwc-details&gt;
## `<govukwc-details>`

### Properties

| Property | Type |
|-----------|-----------|
| `summary` | `string` |
| Property | Type | Default | Description |
|-----------|-----------|---------|-------------|
| summary|string|""|""|

### Slots

Expand Down
Loading

0 comments on commit a85bd6f

Please sign in to comment.