Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 961 Bytes

CyclingLink.md

File metadata and controls

19 lines (14 loc) · 961 Bytes
Raw

CyclingLink

A component that, when clicked, replaces the initial piece of content with another. This component is essentially identical to the component it calls, Clicker, and is here solely for clarity of purpose relative to a lower-level component.

Example

<CyclingLink
  className="test"
  choices={[ 'one', 'two', 'three', 'four', ]}
  variableToSet="myCycleVar"
/>

Property arguments

  • choices (string[]): Each of the string choices that the link will cycle through on click.
  • className (string, optional): An optional, extra class that will be passed on to the rendered container element. Note that, regardless of whether this argument is provided, cyclingLink is still provided as a class to the container element (rendered by Cycler).
  • variableToSet (string, optional): The string corresponding to the state property name you would like to be updated with the current value of the link every time it cycles.