carbon-custom-elements
Version:
A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.
50 lines (42 loc) • 1.12 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 2019, 2020
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import { Component } from 'react';
interface ComponentProps {
/**
* `true` if the button should represent its active state.
*/
active?: boolean;
/**
* The `aria-label` attribute for the button in its active state.
*/
buttonLabelActive?: string;
/**
* The `aria-label` attribute for the button in its active state.
*/
buttonLabelInactive?: string;
/**
* Collapse mode of the side nav.
*/
collapseMode?: string;
/**
* `true` if the button should be disabled.
*/
disabled?: boolean;
/**
* Usage mode of the side nav.
*/
usageMode?: string;
}
/**
* The trigger button for side nav in header nav.
* @element bx-header-menu-button
* @fires bx-header-menu-button-toggled - The custom event fired after this header menu button is toggled upon a user gesture.
*/
declare class BXHeaderMenuButton extends Component<ComponentProps> {}
export default BXHeaderMenuButton;