Sha256: 248973c0329612d9aabc7f037bc5f6390e0b467e5ba7225e8da905d1d2d8bb3f

Contents?: true

Size: 1.67 KB

Versions: 82

Compression:

Stored size: 1.67 KB

Contents

/**
 * Defines a set of helper functions used to construct a component following
 * Playbook's patterns.
 */
import classnames from 'classnames'

/**
 *
 * @param {String} prefix the prefix to be used on the dash separated prop (data, aria, etc...)
 * @param {Object} data the object containing the data to derive the props from.
 * @returns {Object} an object whose keys have the prefix added to them.
 */
const buildPrefixedProps = (prefix, data) => Object.keys(data).reduce((props, key) => {
  props[`${prefix}-${key}`] = data[key]
  return props
}, {})

/**
 * Represent a "No-Operation" function that can be used as a sensible
 * default to event handlers in the absence of a value.
 *
 * @returns {() => {}} the noop function.
 */
export const noop = () => {}

/**
 * Maps a given aria object into HTML valid aria attribtues and their values.
 *
 * @param {Object} aria the object containing the aria prop values.
 * @returns {Object} an object holding the HTML valid aria props and their values.
 */
export const buildAriaProps = (aria) => buildPrefixedProps('aria', aria)

/**
 * Maps a given data object into HTML valid data attribtues and their values.
 *
 * @param {Object} data the object containing the data prop values.
 * @returns {Object} an object holding the HTML valid data props and their values.
 */
export const buildDataProps = (data) => buildPrefixedProps('data', data)

/**
 * Builds a Playbook valid root className off of the incoming css rules.
 *
 * @param {Object} rules a 'classnames' compliant rules object, used to derive the root className.
 * @returns {String} the derived root className value.
 */
export const buildCss = (...rules) => classnames(rules).replace(/\s/g, '_')

Version data entries

82 entries across 82 versions & 1 rubygems

Version Path
playbook_ui-4.8.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.7.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.7.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.6.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.6.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.5.2 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.5.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.5.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.4.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.4.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.3.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.3.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.2.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.1.2 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.1.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.1.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.0.1 app/pb_kits/playbook/utilities/props.js
playbook_ui-4.0.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-3.5.0 app/pb_kits/playbook/utilities/props.js
playbook_ui-3.4.0 app/pb_kits/playbook/utilities/props.js