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

Update documentation for component options #1181

merged 6 commits into from
Feb 13, 2019

Commits on Feb 8, 2019

  1. Document missing attributes options

    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.
    36degrees committed Feb 8, 2019
    Configuration menu
    Copy the full SHA
    b699dca View commit details
    Browse the repository at this point in the history
  2. Remove incorrectly documented describedBy options

    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`.
    36degrees committed Feb 8, 2019
    Configuration menu
    Copy the full SHA
    7a70542 View commit details
    Browse the repository at this point in the history
  3. Correct footer options documentation

    - Use 'params' instead of 'arguments'.
    - Add missing html and text options for the 'meta' section of the footer.
    36degrees committed Feb 8, 2019
    Configuration menu
    Copy the full SHA
    e924c84 View commit details
    Browse the repository at this point in the history

Commits on Feb 12, 2019

  1. Update footer template to avoid reusing variables

    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.
    36degrees committed Feb 12, 2019
    Configuration menu
    Copy the full SHA
    1ba0bde View commit details
    Browse the repository at this point in the history
  2. Remove name from radios options

    Radios do not accept a `name` for each radio button, as unlike checkboxes radios within the same fieldset should always have the same name.
    36degrees committed Feb 12, 2019
    Configuration menu
    Copy the full SHA
    d474ce3 View commit details
    Browse the repository at this point in the history
  3. Add undocumented options for tabs

    - Add undocumented 'title' option
    - Add undocumented `attributes` option for each panel
    - Reformat panel options to be represented as a nested object
    36degrees committed Feb 12, 2019
    Configuration menu
    Copy the full SHA
    1132806 View commit details
    Browse the repository at this point in the history