Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for component options #1181

Merged
merged 6 commits into from
Feb 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/components/breadcrumbs/breadcrumbs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ params:
type: string
required: false
description: Link for the breadcrumbs item. If not specified, breadcrumbs item is a normal list item.
- name: attributes
type: object
description: HTML attributes (for example data attributes) to add to the individual crumb.
- name: classes
type: string
required: false
Expand Down
4 changes: 0 additions & 4 deletions src/components/character-count/character-count.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ params:
type: string
required: true
description: The id of the textarea.
- name: describedBy
type: string
required: false
description: Text or element id to add to the `aria-describedby` attribute to provide description for screenreader users.
- name: name
type: string
required: true
Expand Down
12 changes: 9 additions & 3 deletions src/components/footer/footer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ params:
type: object
required: false
description: Object containing options for the meta navigation.
arguments:
params:
- name: html
type: string
description: HTML to add to the meta section of the footer, which will appear below any links specified using meta.items.
- name: text
type: string
description: Text to add to the meta section of the footer, which will appear below any links specified using meta.items. If meta.html is specified, this option is ignored.
- name: items
type: array
required: false
Expand All @@ -25,7 +31,7 @@ params:
type: array
required: false
description: Array of items for use in the navigation section of the footer.
arguments:
params:
- name: title
type: string
required: false
Expand All @@ -38,7 +44,7 @@ params:
type: array
required: false
description: Array of items to display in the list in navigation section of the footer.
arguments:
params:
- name: text
type: string
required: false
Expand Down
12 changes: 6 additions & 6 deletions src/components/footer/template.njk
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
<div class="govuk-width-container {{ params.containerClasses if params.containerClasses }}">
{% if params.navigation %}
<div class="govuk-footer__navigation">
{% for item in params.navigation %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests have failed on this change, but it looks sensible so not sure why.

{% for nav in params.navigation %}
<div class="govuk-footer__section">
<h2 class="govuk-footer__heading govuk-heading-m">{{ item.title }}</h2>
{% if item.items %}
<h2 class="govuk-footer__heading govuk-heading-m">{{ nav.title }}</h2>
{% if nav.items %}
{% set listClasses %}
{% if item.columns %}
govuk-footer__list--columns-{{ item.columns }}
{% if nav.columns %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The below line will just need updating to {{ nav.columns }} and then the tests will pass again

govuk-footer__list--columns-{{ nav.columns }}
{% endif %}
{% endset %}
<ul class="govuk-footer__list {{ listClasses | trim }}">
{% for item in item.items %}
{% for item in nav.items %}
{% if item.href and item.text %}
<li class="govuk-footer__list-item">
<a class="govuk-footer__link" href="{{ item.href }}"{% for attribute, value in item.attributes %} {{attribute}}="{{value}}"{% endfor %}>
Expand Down
4 changes: 0 additions & 4 deletions src/components/radios/radios.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,6 @@ params:
type: string
required: false
description: Specific id attribute for the radio item. If omitted, then `idPrefix` string will be applied.
- name: name
type: string
required: true
description: Specific name for the radio item. If omitted, then component global `name` string will be applied.
- name: value
type: string
required: true
Expand Down
6 changes: 5 additions & 1 deletion src/components/select/select.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ params:
type: boolean
required: false
description: Sets the option item as disabled.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the option.
- name: label
type: object
required: false
Expand Down Expand Up @@ -59,7 +63,7 @@ params:
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the anchor tag.
description: HTML attributes (for example data attributes) to add to the select.

examples:
- name: default
Expand Down
31 changes: 24 additions & 7 deletions src/components/tabs/tabs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ params:
type: string
required: false
description: String to prefix id for each tab item if no id is specified on each item
- name: title
type: string
required: false
description: Title for the tabs table of contents
- name: items
type: array
required: true
Expand All @@ -20,14 +24,27 @@ params:
type: string
required: true
description: The text label of a tab item.
- name: panel.text
type: string
required: true
description: If `html` is set, this is not required. Text to use within each tab panel. If `html` is provided, the `text` argument will be ignored.
- name: panel.html
type: string
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the tab.
- name: panel
description: Content for the panel
type: object
required: true
description: If `text` is set, this is not required. HTML to use within the each tab panel. If `html` is provided, the `text` argument will be ignored.
params:
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text to use within each tab panel. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML to use within the each tab panel. If `html` is provided, the `text` argument will be ignored.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the tab panel.
- name: classes
type: string
required: false
Expand Down
4 changes: 0 additions & 4 deletions src/components/textarea/textarea.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ params:
type: string
required: true
description: The id of the textarea.
- name: describedBy
type: string
required: false
description: Text or element id to add to the `aria-describedby` attribute to provide description for screenreader users.
- name: name
type: string
required: true
Expand Down