@enymo/react-clickable
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

React Clickable

Simple React Component providing a unified API for working with Buttons and Anchors.

Installation

The library may be installed from npm using

npm i @enymo/react-clickable

Features

  • Write custom, clickable UI Elements that can be used both as buttons and hyperlinks without additional coding
  • Create cleaner applications that adhere to common guidelines by having it pick the correct html tag for a given situation automatically

Usage

The component supports the following props:

Prop Description
className Additional class(es) for the component. Note that a disabled Clickable will always gain the disabled class in addition to those specified with this prop.
style A custom style may be specified for the component
to The target when using the Clickable as a hyperlink. Passing this prop will cause the Clickable to render a <Link> or <a> tag, even if onClick is specified as well.
linkType May be normal or new-tab. Default is normal. new-tab will open the link in a new tab.
disabled Disables the clickable. A button will be set to disabled via prop. Since <a> tags cannot be disabled without some rather sketchy meddling with event propagation, the clickable will render a <div> instead of an Anchor in this case. The disabled class will be added regardless of type.
submit If the clickable renders a button, this prop sets the button type from 'button' to 'submit'. Otherwise, this prop has no effect.

Readme

Keywords

none

Package Sidebar

Install

npm i @enymo/react-clickable

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

24 kB

Total Files

10

Last publish

Collaborators

  • sszajbely
  • jserguhn
  • gritter