@rei/cdr-button

CdrButton

Properties

Name	Type	Default
tag	string	button
Render CdrButton as a <button> or <a> element. When using a value of a, this element renders as an anchor link. Possible values: { button, a }

Name	Type	Default
type	string	button
Set the button type. Possible values: { button, submit, reset}

Name	Type	Default
onClick	function	return null
Add custom click actions.

Name	Type	Default
fullWidth	boolean	false
Set button width to 100%. Setting it to true will set the button width to 100% of the parent container. Use the full-width prop with the size prop to control top and bottom padding.

Name	Type	Default
size	string	medium
Set the button size. Possible values: { small, medium, large }

Name	Type	Default
responsiveSize	array	n/a
Set the button size at different responsive breakpoints. Breakpoints are expressed as t-shirt sizing with values: xs, sm, md, and lg. Example: [‘large@xs’, ‘small@lg’]

Name	Type	Default
iconOnly	boolean	false
Renders an icon-only button. Overrides size and responsiveSize props.

Name	Type	Default
onDark	boolean	false
Renders an icon-only button with a light fill color for use on dark backgrounds. iconOnly must also be true.

Slots

All CdrButton components have two slots.

Name	Notes
Default	Slot for button text. Leave empty if icon-only
icon	Slot for the icon

Additional Properties

Name	Type	Value
modifier	string	Allows style variants to be defined.

Modifiers

Following are modifiers for cdrButton component:

• Secondary

Installation

Resources are available within the cdr-button package:

Name	Type	Description
@rei/cdr-button	Node module package	Import the component into your project
cdr-button.css	Style sheet	Component specific styles

To incorporate the required assets for a component, use the following steps:

1. Install using NPM

Install the cdr-button package using npm in your terminal:

Terminal

    npm i -s @rei/cdr-button

2. Import dependencies

main.js

// import your required css.
import "@rei/cdr-link/dist/cdr-button.css";

3. Add component to a template

In this example we’ll create a medium-sized primary button, which is the default.

local.vue

<template>
  <cdr-button
    type="button"
  >
    Add to cart
  </cdr-button>
</template>

<script>
import { CdrButton } from '@rei/cdr-button';
export default {
  ...
  components: {
     CdrButton  
  }
}
</script>

Usage

Size, responsive size, and full-width sizing props

The below example uses both the size and responsive-size props. This button’s size is small, but it will become a large button at the xs and sm breakpoints.

<template>
  <cdr-button
    size="small"
    :responsive-size="[‘large@xs’, ‘large@sm’]"
  >
    Add to cart
  </cdr-button>
</template>

Composing with icons

cdr-button can be used with the icon component from the @rei/cdr-icon package.

Text and Icon

To scale Cedar icons appropriately, include the cdr-button__icon class with any icon component. The size prop scales both the icon and button.

In the below example, a Download button is rendered as a button with icon and text using cdr-icon and the icon sprite.

<template>
  <cdr-button>
    <cdr-icon
      slot="icon"
      class="cdr-button__icon"
      use="#download"
    />
    Download
  </cdr-button>
</template>

<script>
import { CdrButton } from '@rei/cdr-button';
import { CdrIcon } from '@rei/cdr-icon;
export default {
  ...
  components: {
     CdrButton,
     CdrIcon,  
  }
}
</script>

Icon Only

Use the following props to modify cdr-button:

• Default slot must be empty. If text is present in default slot, the text will render
• Size prop is disable when icon-only prop is true
• For the SVG files:
  • If the fill color is dark, assign true to the on-dark prop
  • On-dark prop only works if icon-only prop is also true
• Add aria-label text to describe the button’s action when clicked or tapped

<template>
  <cdr-button
    :icon-only="true"
    :on-dark="true"
    aria-label="Complete this step"
  >
    <icon-check-lg
      slot="icon"
      class="cdr-button__icon" />
  </cdr-button>
</template>

Click Actions

Use the on-click prop to attach custom actions and event handling.

<template>
  <cdr-button
    :on-click="greet"
  >
    Greet
  </cdr-button>
</template>

<script>
export default {
  ...
  methods: {
    greet() {
      console.log(‘Hello there’);
    }
  }
}
</script>

CdrCloseButton & CdrPlayButton

The cdr-button package includes two specific icon-only variants. CdrCloseButton and CdrPlayButton include their respective icons and aria-label text for accessibility.

<template>
  <cdr-close-button />
</template>

<script>
import { CdrCloseButton } from '@rei/cdr-button';

export default {
  ...
  components: {
     CdrCloseButton  
  }
}
</script>

Accessibility

• Cdr-button renders as a button or anchor:
  • Select the semantically correct element, which will ensure that screen readers have correct instructions for how to interact with the component
  • Use cdr-link to make a button that looks like a link
  • Do not use div or input elements
• Do not add role=”button” to cdr-button
• Icon-only buttons require aria-label text since only the icon is visible