@dotconnor/grommet/contexts/AnnounceContext/doc.js

focus on the essential experience

"use strict";

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

var _reactDesc = require("react-desc");

var _mixins = require("../../utils/mixins");

var doc = function doc(AnnounceContext) {
  var DocumentedAnnounceContext = (0, _reactDesc.describe)(AnnounceContext).availableAt((0, _mixins.getAvailableAtBadge)('AnnounceContext')).description('A means of announcing events for screen readers.').usage("import { AnnounceContext } from 'grommet';\n" + '<AnnounceContext.Consumer />\n{announce => ()}');
  DocumentedAnnounceContext.propTypes = {
    children: _reactDesc.PropTypes.func.description("Render function that will be called with an 'announce' function that\n      can be called when something should be announced.\n      'announce' function accepts 'message', 'mode' and 'timeout' as arguments\n      and these arguments can be passed as 'props' to the return component.\n      'mode' can be one of 'polite', 'assertive' or 'off'.\n      'timeout' is measured in milliseconds.\n      Example:\n      {announce =>\n        <Button onClick={() => announce(\n          \"Button was clicked\",\n          \"polite\",\n          1000\n        )\n      }\n      ")
  };
  return DocumentedAnnounceContext;
};

exports.doc = doc;