Update documentation for component options #1181
Conversation
The breadcrumbs accept attributes on each individual 'crumb', but this isn't documented. The select accepts attributes on each individual <option>, but this isn't documented.
describedBy is listed as an option for both the character count and the textarea component, but in both cases this is actually a variable used only within the component, that cannot be passed in as part of `params`.
- Use 'params' instead of 'arguments'. - Add missing html and text options for the 'meta' section of the footer.
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1181
| @@ -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 %} | |||
There was a problem hiding this comment.
The tests have failed on this change, but it looks sensible so not sure why.
|
outputed class is |
|
Good catch, thanks @igloosi 👍 |
| {% set listClasses %} | ||
| {% if item.columns %} | ||
| {% if nav.columns %} |
There was a problem hiding this comment.
The below line will just need updating to {{ nav.columns }} and then the tests will pass again
Currently we reuse the `item` variable within a nested for loop (`{% for item in params.navigation %}` is the outer loop, `{% for item in item.items %}` is the inner loop), which makes it difficult to understand what is going on (I'm surprised this works!)
This updates the outer loop to use `{% for nav in params.navigation %}` instead.
Radios do not accept a `name` for each radio button, as unlike checkboxes radios within the same fieldset should always have the same name.
- Add undocumented 'title' option - Add undocumented `attributes` option for each panel - Reformat panel options to be represented as a nested object
36degrees
force-pushed
the
update-options
branch
from
7a6de22
to
1132806
Compare
|
technically I think this should be a fix in the changelog, but it depends on the regard of macro-options.json as being part of the public API |
|
macro-options is not documented so it's not part of the public api, updating the template.njk did not change anything for users or the api. So given that I'd argue these are all internal changes? |
|
dilemma solved |
This corrects a bunch of issues with the documentation for our components, off the back of some exploratory work into testing the documentation – which is really hard, and not something we're ready to merge yet.
See the individual commits for details.