# @singlestone/tailwind-plugin-form-sugar

> Tailwind plugin for sugar design system buttons

Latest version **0.6.2** (published 2023-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @singlestone/tailwind-plugin-form-sugar
pnpm add @singlestone/tailwind-plugin-form-sugar
yarn add @singlestone/tailwind-plugin-form-sugar
bun add @singlestone/tailwind-plugin-form-sugar
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.2 |
| Published | 2023-03-03 |
| First published | 2022-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^14 \|\| ^16 \|\| >= 18 |
| Dependencies | 1 |
| Unpacked size | 81.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | SingleStone Consulting |
| Maintainers | sugarssc, terry.brown, rharrahssc, singlestone_admin, chrisbelyea |

## Links

- npm: https://www.npmjs.com/package/@singlestone/tailwind-plugin-form-sugar
- Repository: https://github.com/singlestone/sugar
- Homepage: https://github.com/singlestone/sugar/tree/main/sugar/tailwind-plugin-form-sugar#readme
- Issues: https://github.com/singlestone/sugar/issues
- npm.io page: https://npm.io/package/@singlestone/tailwind-plugin-form-sugar

## Dependencies (1)

- [@singlestone/tailwind-helpers-sugar](https://npm.io/package/@singlestone/tailwind-helpers-sugar.md) ^0.6.2

## Recent versions

- 0.6.2 (latest) — 2023-03-03
- 0.6.0 — 2023-02-23
- 0.5.6 — 2023-02-15
- 0.5.2 — 2023-02-06
- 0.5.0 — 2023-02-06
- 0.4.1 — 2023-01-31
- 0.3.0 — 2022-12-10
- 0.2.1 — 2022-08-11
- 0.1.0 — 2022-08-10

## README

# tailwind-plugin-form

> Form plugin for the sugar design system

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Prerequisites](#prerequisites)
- [Installation](#installation)
  - [npm](#npm)
  - [Yarn](#yarn)
  - [pnpm](#pnpm)
- [Setup](#setup)
- [Usage](#usage)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Prerequisites

- NodeJS 14+
- A functioning [Tailwind setup](https://tailwindcss.com/docs/installation)

## Installation

Install `@singlestone/tailwind-plugin-form-sugar` with your NodeJS package manager of choice.

### npm

```shell
$ npm install -D @singlestone/tailwind-plugin-form-sugar
```

### Yarn

```shell
$ yarn add -D @singlestone/tailwind-plugin-form-sugar
```

### pnpm

```shell
$ pnpm install -D @singlestone/tailwind-plugin-form-sugar
```

## Setup

After [installation](#installation), add Sugar to your `tailwind.config.js` like so:

```js
// tailwind.config.js
module.exports = {
  mode: "jit",
  content: [
    // change this to fit your project as necessary
    "./src/**/*.{ts,tsx}",
    "./index.html",
  ],
  plugins: [
    require("@singlestone/tailwind-plugin-form-sugar").sugarFormsPlugin(),
  ],
};
```

## Usage

Once you've followed the [Installation](#installation) and [Setup](#setup) process, you can use the CSS classes
generated in your JavaScript and HTML.

Check out our [Storybook](https://sugar.singlestone.io) for examples on how to do so.

---
_Source: https://npm.io/package/@singlestone/tailwind-plugin-form-sugar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
