npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@synerise/ds-button

v0.21.19

Published

Button UI Component for the Synerise Design System

Downloads

3,766

Readme

import { version } from './package.json';
`Current version: ${version}`;

Storybook

Buttons allow users to take actions, and make choices, with a single tap. Buttons communicate actions that users can take. They are typically placed throughout your UI, in places such as dialogs, modal windows, forms, cards, and toolbars.

Inspired by Ant Design Button

When to use it

  • To produce things that didn’t exist before (register, submit, save, and more).
  • To perform actions (send, delete, edit, cancel, and more).
  • To confirm the displayed information.
  • Generally, to be used when actions caused by users affect back-end and/or front-end of the application.

Component anatomy

This is a simple component, which means that it doesn't consist of other components.

Installation

npm i @synerise/ds-button

or

yarn add @synerise/ds-button

Usage

import Icon from '@synerise/ds-icon';
import { AngleDownS } from '@synerise/ds-icon';
<div>
    <Button mode="split" type="custom-color" color="green">
        Click
        <Icon component={<AngleDownS />} />
    </Button>
</div>

Button

| Property | Description | Type | Default | | -------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | color | Defines color of custom-color button. | green / grey / yellow / blue / pink/ mars/ orange/ fern/ cyan/ purple / violet | red | | disabled | Defines if the button is disabled. | boolean | false | | groupVariant | Defines shape of the button | left-rounded / squared / right-rounded | - | | justifyContent | Defines justify of content in button. | JustifyContentProperty (React.CSSPRroperties) | - | | loading | Sets the loading status of button. | boolean / { delay?: number } | false | | mode | Defines the mode of the button content. It affects content inside the button | single-icon / split / two-icons /label-icon / icon-label | - | | onClick | Callback executed after clicking the button | (event: React.MouseEvent) => void | - | | type | Defines the type of the button. | primary / secondary/ tertiary/ tertiary-white / ghost-primary / ghost / ghost-white / custom-color / custom-color-ghost | secondary | | iconColor | Defines color of icon in button. | green / grey / yellow / blue / pink/ mars/ orange/ fern/ cyan/ purple / violet | grey | | error | Defines if the button has error button styles . | boolean | false | | activated | Defines if the button has activated button styles . | boolean | false |

Button.Creator

| Property | Description | Type | Default | | -------- | ------------------------------------------------------ | ---------------------------------------------- | --------- | | block | Defines if the button should take all available space. | boolean | false | | disabled | Defines if the button is disabled. | boolean | false | | label | Label of the button. | string / React.ReactNode | - | | onClick | Callback executed after clicking the button | (event: React.MouseEvent) => void | - | | status | Defines the color of the button. | upload / error/ default | default |

Button.Expander

| Property | Description | Type | Default | | -------- | ------------------------------------------- | ---------------------------------------------- | ------- | | disabled | Defines if the button is disabled. | boolean | false | | expanded | The current state of the button. | boolean | false | | onClick | Callback executed after clicking the button | (event: React.MouseEvent) => void | - | | size | Defines the size of the button. | S / M | M |

Button.Checkbox

This is special checkbox built on Button and inheriting its appereance. It behaves like checkbox input due to role="checkbox" and aria-checked attributes.

Props

It inherits all Button's props excluding type, block, color, groupVariant, icon, iconColor, leftIconSize, mode, rightIconSize, size, onChange.

| Property | Description | Type | Default | |----------------|------------------------------------------------------------|------------------------------|-------------| | checked | (optional) Sets checkbox state for controlled component. | boolean | undefined | | defaultChecked | (optional) Sets checkbox state for uncontrolled component. | boolean | false | | hasError | (optional) Changes appereance for wrong validation. | boolean | undefined | | indeterminate | (optional) Forces indeterminate checkbox state. | boolean | undefined | | onChange | (optional) On change callback | (checked: boolean) => void | |

Button.Star

This is star toggle built on Button and inheriting its appereance.

Props

It inherits all Button's props excluding.

| Property | Description | Type | Default | |----------------|------------------------------------------------------------|------------------------------|-------------| | active | (optional) Sets checkbox state for controlled component. | boolean | undefined |