Package Exports

@commercetools-uikit/secondary-icon-button
@commercetools-uikit/secondary-icon-button/dist/commercetools-uikit-secondary-icon-button.cjs.js
@commercetools-uikit/secondary-icon-button/dist/commercetools-uikit-secondary-icon-button.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commercetools-uikit/secondary-icon-button) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SecondaryIconButton

Description

Secondary Icon Buttons are "icon-only" buttons and a restricted version of the `<IconButton>`. They trigger an action when clicked (`onClick` prop). You must also pass a label for accessibility reasons.

Installation

yarn add @commercetools-uikit/secondary-icon-button

npm --save install @commercetools-uikit/secondary-icon-button

Additionally install the peer dependencies (if not present)

yarn add react

npm --save install react

Usage

import SecondaryIconButton from '@commercetools-uikit/secondary-icon-button';
import { InformationIcon } from '@commercetools-uikit/icons';

const Example = () => (
  <SecondaryIconButton
    icon={<InformationIcon />}
    label="A label text"
    onClick={() => alert('Button clicked')}
  />
);

export default Example;

Properties

Props	Type	Required	Default	Description
`as`	`TStringOrComponent`			You may pass in a string like "a" to have the button element render an anchor tag, or you could pass in a React Component, like a `Link`. The `<SecondaryIconButton>` additionally accepts any props or attributes specific to the given element or component.
`type`	`union` Possible values: `'submit' , 'reset' , 'button'`		`'button'`	Used as the HTML type attribute.
`icon`	`ReactElement`			An component.
`color`	`union` Possible values: `'solid' , 'primary'`		`'solid'`	Indicates the color scheme of the button.
`label`	`string`	✅		Should describe what the button does, for accessibility purposes (screen-reader users)
`isDisabled`	`boolean`		`false`	Tells when the button should present a disabled state.
`size`	`union` Possible values: `'small' , 'medium' , 'big'`		`'big'`	Indicates the size of the icon.
`onClick`	`Function` See signature.			Handler when the button is clicked.

Signatures

Signature `onClick`

(
  event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>
) => void

The component further forwards all valid HTML attributes to the underlying button component.

Note

The size of the button should be adjusted directly on the passed Icon component. Example:

<SecondaryIconButton
  icon={<ArrowRightIcon size="small" />}
  label="Next"
  onClick={() => alert('Button clicked')}
/>

Examples in the Merchant Center

Mostly in all places where you just need a "clickable" icon, without the complex behaviors of the IconButton.

Pagination list: Go to next page

@commercetools-uikit/secondary-icon-button