Skip to content

Commit

Permalink
Update warning text README
Browse files Browse the repository at this point in the history
In [#432](#432) changes were made directly to README.md that should have been made in index.njk, mainly to update references to the component name, but also to change the 'description' to remove a reference to legal consequences.

This updates index.njk to include the change to the description and regenerates the readme with the correct whitespace and capitalisation as well as changes to the arguments table and to the macro example.
  • Loading branch information
36degrees committed Jan 18, 2018
1 parent eaaac55 commit b416beb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
24 changes: 18 additions & 6 deletions src/components/warning-text/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Warning text
# Warning text

## Introduction

Use bold text with an exclamation icon if there are consequences - for example, a fine or prison sentence.
Use bold text with an exclamation icon if there are consequences - for example, a fine or prison sentence.

## Guidance

Expand All @@ -26,9 +26,9 @@ More information about when to use warning-text can be found on [GOV.UK Design S

#### Macro

{{ govukwarningText({
{{ govukWarningText({
"classes": null,
"warningText": "You can be fined up to £5,000 if you don’t register.",
"text": "You can be fined up to £5,000 if you don’t register.",
"iconFallbackText": "Warning"
}) }}

Expand Down Expand Up @@ -106,7 +106,19 @@ If you are using Nunjucks,then macros take the following arguments

<tr class="govuk-c-table__row">

<th class="govuk-c-table__header" scope="row">warningText</th>
<th class="govuk-c-table__header" scope="row">text</th>

<td class="govuk-c-table__cell ">string</td>

<td class="govuk-c-table__cell ">Yes</td>

<td class="govuk-c-table__cell ">The text next to the icon</td>

</tr>

<tr class="govuk-c-table__row">

<th class="govuk-c-table__header" scope="row">html</th>

<td class="govuk-c-table__cell ">string</td>

Expand Down Expand Up @@ -146,4 +158,4 @@ Guidelines can be found at [on our Github repository.](https://github.com/alphag

## License

MIT
MIT
2 changes: 1 addition & 1 deletion src/components/warning-text/index.njk
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{# componentName #}
{% block componentDescription %}
Use bold text with an exclamation icon if there are legal consequences - for example, a fine or prison sentence.
Use bold text with an exclamation icon if there are consequences - for example, a fine or prison sentence.
{% endblock %}
{# defaultAndVariants #}

Expand Down

0 comments on commit b416beb

Please sign in to comment.