carbon-react/lib/components/heading/definition.js

A library of reusable React components and an interface for easily building user interfaces based on Flux.

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _ = require('./');

var _2 = _interopRequireDefault(_);

var _definition = require('./../../../demo/utils/definition');

var _definition2 = _interopRequireDefault(_definition);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

var definition = new _definition2.default('heading', _2.default, {
  description: 'The titles of a page and its sections.',
  designerNotes: '\n* A standard page or section header, with a range of options, such as a help link presented as an icon, a sub-heading, a \u2018Back\u2019 icon, and visual dividers and separators.\n* Make sure that the colour of all text has a contrast ratio of at least 4.5.1, to meet the [WCAG 2.0 AA standard](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html) for text less than 19px in size. Webaim have a good online [Contrast Checker](http://webaim.org/resources/contrastchecker/).\n  ',
  relatedComponentsNotes: '\n* Simple text content? [Try Content](/components/content).\n* Prominent text callout? [Try Detail](/components/detail).\n ',
  type: 'layout',
  propTypes: {
    title: "String",
    subheader: "String",
    help: "String",
    helpLink: "String",
    backLink: "String",
    divider: "Boolean",
    separator: "Boolean"
  },
  propDescriptions: {
    title: "Sets the title for the heading.",
    subheader: "Sets the subheader for the heading.",
    help: "Sets the help text for the heading.",
    helpLink: "Sets the help url for the heading.",
    backLink: "Defines the back button link and toggles its visibility if set.",
    divider: "Adds a divider below the heading and the content.",
    separator: "Adds a separator between the title and subheader."
  },
  propValues: {
    title: 'Heading Component',
    subheader: 'Subheading'
  }
});

exports.default = definition;