2.0.0 • Published 2 months ago

@leafygreen-ui/split-button v2.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

Split Button

npm (scoped)

View on MongoDB.design

Installation

Yarn

yarn add @leafygreen-ui/split-button

NPM

npm install @leafygreen-ui/split-button

Example

import { SplitButton } from `@leafygreen-ui/split-button`;
import { MenuItem } from '@leafygreen-ui/menu';

<SplitButton
  label="label"
  menuItems={
    [
      <MenuItem key='0'>Menu Item</MenuItem>,
      <MenuItem key='1' disabled>Disabled Menu Item</MenuItem>,
      <MenuItem key='2' description="I am also a description">
        Menu Item With Description
      </MenuItem>
    ]
  }
/>

Properties

PropTypeDescriptionDefault
labelstringThe text that will appear inside of the primary button.
darkModebooleanRenders the component with dark mode styles.false
variant'default' | 'primary' | 'danger'Sets the variant for both Buttons.'default'
size'xsmall' | 'small' | 'default' | 'large'Sets the size for both buttons.'default'
align'top' | 'bottom'Determines the alignment of the menu relative to the component wrapper.'bottom'
justify'start' | 'end'Determines the justification of the menu relative to the component wrapper.'end'
menuItemsArray<MenuItem>The menu items to appear in the menu dropdown. Must be an array of <MenuItem />.
onTriggerClickReact.MouseEventHandlerCallback fired when the trigger is clicked.
triggerAriaLabelstringaria-label for the menu trigger button.
onChangeReact.MouseEventHandlerCallback fired when a menuItem is clicked.
portalContainerHTMLElement | nullSets the container used for the popover's portal. NOTE: If using a scrollContainer make sure that the portalContainer is contained within the scrollContainer. E.g, passing the same reference to scrollContainer and portalContainer.
scrollContainerHTMLElement | nullIf the popover portal has a scrollable ancestor other than the window, this prop allows passing a reference to that element to allow the portal to position properly.
portalClassNamestringPasses the given className to the popover's portal container if the default portal container is being used.
popoverZIndexnumberSets the z-index CSS property for the popover.
...native attributes of component passed to as propAny other properties will be spread on the root element
2.0.0

2 months ago

1.1.1

6 months ago

1.1.0

7 months ago

1.1.3

4 months ago

1.1.2

6 months ago

1.0.13

8 months ago

1.0.12

9 months ago

1.0.11

9 months ago

1.0.11-popover.0

11 months ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

2.0.0-alpha.0

1 year ago

2.0.0-alpha.1

1 year ago

1.0.10

1 year ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago