@gitlab/ui/dist/components/base/toggle/toggle.documentation.js

GitLab UI Components

import examples from './examples';

var toggle = "# Toggle\n\n## Usage\n\nThe toggle component must have a `label` prop to give the toggle button an accessible name.\nTo visually hide the label, provide it with `label-position=\"hidden\"`.\n";

var description = /*#__PURE__*/Object.freeze({
  __proto__: null,
  'default': toggle
});

var toggle_documentation = {
  description: description,
  followsDesignSystem: true,
  examples: examples,
  events: [{
    event: 'change',
    description: 'Emitted when the state changes',
    args: [{
      arg: 'value',
      description: 'Whether the toggle is in the enabled'
    }]
  }]
};

export default toggle_documentation;