@procore/core-react
Version:
React library of Procore Design Guidelines
21 lines (13 loc) • 919 B
TypeScript
import React from 'react';
import type { ToggleButtonProps } from './ToggleButton.types';
/**
A toggle button can be used when an element needs to remain active or open
for extended periods of time. The affects of a toggle button should visibly
change content on the page.
@since 10.19.0
@see [Storybook](https://stories.core.procore.com/?path=/story/core-react_demos-togglebutton--demo)
@see [Design Guidelines](https://design.procore.com/toggle-button)
@a11y @a11y Important: it is critical the label on a toggle does not change when its `selected` prop changes. Alternatively, if the design were to call for the button label to change from "Mute" to "Unmute," the `aria-pressed` prop should be set to `undefined`.
@see https://www.w3.org/WAI/ARIA/apg/patterns/button/
*/
export declare const ToggleButton: React.ForwardRefExoticComponent<ToggleButtonProps & React.RefAttributes<HTMLButtonElement>>;