-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
281 additions
and
402 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-accordion> | ||
## `<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` | | ||
|
||
## <govukwc-accordion-section> | ||
## `<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` | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-back-link> | ||
## `<govukwc-back-link>` | ||
|
||
### Properties | ||
|
||
| Property | Type | | ||
|-----------|-----------| | ||
| `url` | `string` | | ||
| `label` | `string` | | ||
| Property | Type | Default | Description | | ||
|-----------|-----------|---------|-------------| | ||
| url|string|""|"" | ||
| label|string|""|""| | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-breadcrumbs> | ||
## `<govukwc-breadcrumbs>` | ||
|
||
### Properties | ||
|
||
| Property | Type | | ||
|-----------|-----------| | ||
| `items` | `array` | | ||
| Property | Type | Default | Description | | ||
|-----------|-----------|---------|-------------| | ||
| items|array|""|""| | ||
|
||
## <govukwc-breadcrumbs-item> | ||
## `<govukwc-breadcrumbs-item>` | ||
|
||
### Properties | ||
|
||
| Property | Type | | ||
|-----------|-----------| | ||
| `url` | `string` | | ||
| `label` | `string` | | ||
| Property | Type | Default | Description | | ||
|-----------|-----------|---------|-------------| | ||
| url|string|""|"" | ||
| label|string|""|""| | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-character-count> | ||
## `<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|""|""| | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-checkboxes> | ||
## `<govukwc-checkboxes>` | ||
|
||
### Properties | ||
|
||
| Property | Type | | ||
|-----------|-----------| | ||
| `legend` | `string` | | ||
| `hint` | `string` | | ||
| Property | Type | Default | Description | | ||
|-----------|-----------|---------|-------------| | ||
| legend|string|""|"" | ||
| hint|string|""|""| | ||
|
||
## <govukwc-checkbox> | ||
## `<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|""|""| | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
## <govukwc-date-input> | ||
## `<govukwc-date-input>` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.