Sha256: f01731543563b68547b3d02c001ef4806a5911cee47432392886455bdabf92e2

Contents?: true

Size: 1.04 KB

Versions: 16

Compression:

Stored size: 1.04 KB

Contents

module GovukPublishingComponents
  module ComponentWrapperHelperOptions
    def self.description
      "
This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the [component wrapper helper documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/component-wrapper-helper.md) for more detail.

- `id` - accepts a string for the element ID attribute
- `data_attributes` - accepts a hash of data attributes
- `aria` - accepts a hash of aria attributes
- `classes` - accepts a space separated string of classes, these should not be used for styling and must be prefixed with `js-`
- `role` - accepts a space separated string of roles
- `lang` - accepts a language attribute value
- `open` - accepts an open attribute value (true or false)
- `hidden` - accepts an empty string, 'hidden', or 'until-found'
- `tabindex` - accepts an integer. The integer can also be passed as a string.
- `dir` - accepts 'rtl', 'ltr', or 'auto'.
      "
    end
  end
end

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
govuk_publishing_components-46.3.1 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-46.3.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-46.2.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-46.1.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-46.0.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.10.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.9.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.8.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.7.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.6.1 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.6.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.5.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.4.1 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.4.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.3.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb
govuk_publishing_components-45.2.0 app/models/govuk_publishing_components/component_wrapper_helper_options.rb