@helpscout/hsds-react/components/VisuallyHidden/VisuallyHidden.js

React component library for Help Scout's Design System

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

exports.__esModule = true;
exports.default = void 0;

var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));

var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));

var _react = _interopRequireDefault(require("react"));

var _propTypes = _interopRequireDefault(require("prop-types"));

var _getValidProps = _interopRequireDefault(require("@helpscout/react-utils/dist/getValidProps"));

var _classnames = _interopRequireDefault(require("classnames"));

var _VisuallyHidden = require("./VisuallyHidden.css");

var _jsxRuntime = require("react/jsx-runtime");

var VisuallyHidden = function VisuallyHidden(props) {
  var children = props.children,
      className = props.className,
      focusable = props.focusable,
      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["children", "className", "focusable"]);
  var componentClassName = (0, _classnames.default)('c-VisuallyHidden', focusable && 'is-focusable', className);
  var tabIndex = focusable ? 1 : undefined;
  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_VisuallyHidden.VisuallyHiddenUI, (0, _extends2.default)({}, (0, _getValidProps.default)(rest), {
    className: componentClassName,
    tabIndex: tabIndex,
    children: children
  }));
};

VisuallyHidden.defaultProps = {
  focusable: false,
  'data-cy': 'VisuallyHidden'
};
VisuallyHidden.propTypes = {
  children: _propTypes.default.any,

  /** Custom class names to be added to the component. */
  className: _propTypes.default.string,

  /** Data attr for Cypress tests. */
  'data-cy': _propTypes.default.string,

  /** Enables the ability to be tab focused. */
  focusable: _propTypes.default.bool,

  /** Aria role to assign to the element */
  role: _propTypes.default.string
};
var _default = VisuallyHidden;
exports.default = _default;