Button

ariaControls

string

Pass the id string of the element the Button controls when it's used to expand or open a panel. Use it along with ariaExpanded.

const { expanded } = this.state;
const panelId = 'content-panel';

return (
  <>
    <Button ariaControls={panelId} ariaExpanded={expanded}>
      Expand content
    </Button>
    <div id={panelId} hidden={!expanded}>
      Content
    </div>
  </>
);

ariaExpanded

boolean

Use it to indicate whether the element the Button controls is expanded or not.Recommended to also check ariaControls and ariaHasPopup examples.

ariaHasPopup

boolean|string

Use it to indicate that the Button toggles an interactive overlay element.The value can be:

• false (default) indicates the element does not have a popup.

• true indicates the popup has a menu role

• "menu" indicates the popup has a menu role

• "listbox" indicates the popup has a listbox role

• "tree" indicates the popup has a tree role

• "grid" indicates the popup has a grid role

• "dialog" indicates the popup has a dialog role Read WAI ARIA specifications for this attribute to know which one suits better for your use case.

  const { modalHidden } = this.state;
  
  return (
    <>
      <Button
        ariaHasPopup="dialog"
        ariaExpanded={!modalHidden}
        onClick={() => this.setState({ modalHidden: false })}
      >
        Open modal
      </Button>
      <Modal
        hidden={modalHidden}
        onClose={() => this.setState({ modalHidden: true })}
      />
    </>
  );

  Copia

ariaLabel

string

Use it to describe better the context of the component's action or in buttons displaying only an icon for users on screen readers.

<Button
  iconType={Button.ICON_TYPE.INTERFACE__OPERATIONS__SEARCH}
  ariaLabel="Search for entities"
/>;

children

node

Content to render inside the button.

className

string

Appends class names to the component.Should be used only for positioning and spacing purposes.

disabled

boolean

Use the disabled state for a button prior to a user filling out the required fields of a form or when a user must complete some other task before the button can be enabled.

iconType

enum

Icon to display. <One of

loading

boolean

To indicate whether an action is in progress, especially in the case that it takes more than 1 second to complete, you should display the loading state.

onClick

function

Callback fired any time the user clicks on the button. function (

sizeType

enum

We recommend you use the normal size button in almost all instances.Use the slim button sparingly as it diminishes the importance of the button. Do not use it solely to fit into a space, but consider increasing the space around a default button.The few cases to use a large button are in marketing-like material for your add-on: introducing it in a splash page or in a hero message. <One of

spacingType

enum[]

Spacing property. Spacing is defined as a tuple of zero to four values, which follow the same conventions as CSS properties like margin or padding. To omit a value, use SPACING_TYPE.OMIT. <Array of

style

object

Inline style for custom styling.Should be used only for positioning and spacing purposes.

testId

string

Adds a data-test-id attribute. Use it to target the component in unit and E2E tests.For a test id to be valid, prefix it with your nerdpack id, followed up by a dot.For example, my-nerdpack.some-element.Note: You might not see data-test-id attributes as they are removed from the DOM, to debug them pass a e2e-test query parameter to the URL.

to

shape|string

Location object or url string to link to.

shape

pathname

REQUIRED

string

search

string

hash

string

type

enum

Type can be:

• Primary — use to call attention to one specific action you want the user to take as a next step.
• Normal (used as secondary) — use when multiple actions need to be displayed.
• Outline — use for important actions that are not the main (primary) action of a given view. This variation sits in between the primary and default buttons in terms of hierarchy.
• Plain — use when multiple actions need to be available that are less important for the user to take.
• Destructive — use when you have a destructive action like delete or remove, which you would like the user to pause and consider before completing. <One of
  Button.TYPE.DESTRUCTIVE, Button.TYPE.NORMAL, Button.TYPE.OUTLINE, Button.TYPE.PLAIN, Button.TYPE.PLAIN_NEUTRAL, Button.TYPE.PRIMARY
  >