Skip to content

A small collection of utilities to ease working with hashes of HTML attributes

License

Notifications You must be signed in to change notification settings

x-govuk/html-attributes-utils

Repository files navigation

HTML Attributes Utilities

Tests Maintainability Test Coverage GitHub Supported ruby versions Supported rails versions

This is a small library intended to make it easier to deal with HTML attributes. It was written to reduce overlap in the govuk-components and govuk-formbuilder libraries.

It provides refinements for Hash that allow:

  • deep merging while protecting default values from being overwritten
  • tidying hashes by removing key/value pairs that have empty or nil values

Example use

require "html_attributes_utils"

def MyPresenter
  using HTMLAttributesUtils

  def initialize(custom_attributes = {})
    @custom_attributes = custom_attributes
  end

  def attributes
    default_attributes
      .deep_merge_html_attributes(@custom_attributes)
      .deep_tidy_html_attributes
  end

private

  def default_attributes
    { lang: "en-GB", class: "govuk-juggling-widget" }
  end
end

MyPresenter.new(lang: "fr", class: "stripes", some_other_attr: "").attributes

=> { lang: "fr", class: ["govuk-juggling-widget", "stripes"] }

About

A small collection of utilities to ease working with hashes of HTML attributes

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages