# coffeekraken-s-form-component

> Full stack form styling with support of form-input, form-textarea, form-select, form-group and form-addon as well as colored versions of them...

Latest version **1.0.3** (published 2018-06-14) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install coffeekraken-s-form-component
pnpm add coffeekraken-s-form-component
yarn add coffeekraken-s-form-component
bun add coffeekraken-s-form-component
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-06-14 |
| First published | 2018-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 315.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Coffeekraken |
| Maintainers | coffeekraken |
| Keywords | form, input, select, textarea, addon, group, webcomponent, component, html, sugar, coffee, kraken, coffeekraken |

## Links

- npm: https://www.npmjs.com/package/coffeekraken-s-form-component
- Repository: https://github.com/coffeekraken/s-form-component
- Homepage: http://coffeekraken.io
- Issues: https://github.com/coffeekraken/s-form-component/issues
- npm.io page: https://npm.io/package/coffeekraken-s-form-component

## Dependencies (1)

- [coffeekraken-sugar](https://npm.io/package/coffeekraken-sugar.md) ^1.0.5

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2018-06-14
- 1.0.2 — 2018-06-01
- 1.0.1 — 2018-05-25
- 1.0.0 — 2018-05-18

## README

# Coffeekraken s-form-component <img src=".resources/coffeekraken-logo.jpg" height="25px" />

<p>
	<!-- <a href="https://travis-ci.org/coffeekraken/s-form-component">
		<img src="https://img.shields.io/travis/coffeekraken/s-form-component.svg?style=flat-square" />
	</a> -->
	<a href="https://www.npmjs.com/package/coffeekraken-s-form-component">
		<img src="https://img.shields.io/npm/v/coffeekraken-s-form-component.svg?style=flat-square" />
	</a>
	<a href="https://github.com/coffeekraken/s-form-component/blob/master/LICENSE.txt">
		<img src="https://img.shields.io/npm/l/coffeekraken-s-form-component.svg?style=flat-square" />
	</a>
	<!-- <a href="https://github.com/coffeekraken/s-form-component">
		<img src="https://img.shields.io/npm/dt/coffeekraken-s-form-component.svg?style=flat-square" />
	</a>
	<a href="https://github.com/coffeekraken/s-form-component">
		<img src="https://img.shields.io/github/forks/coffeekraken/s-form-component.svg?style=social&label=Fork&style=flat-square" />
	</a>
	<a href="https://github.com/coffeekraken/s-form-component">
		<img src="https://img.shields.io/github/stars/coffeekraken/s-form-component.svg?style=social&label=Star&style=flat-square" />
	</a> -->
	<a href="https://twitter.com/coffeekrakenio">
		<img src="https://img.shields.io/twitter/url/http/coffeekrakenio.svg?style=social&style=flat-square" />
	</a>
	<a href="http://coffeekraken.io">
		<img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=flat-square&label=coffeekraken.io&colorB=f2bc2b&style=flat-square" />
	</a>
</p>

Full stack form styling with support of form-input, form-textarea, form-select, form-group and form-addon as well as colored versions of them...

## Table of content

1. **[Demo](http://components.coffeekraken.io/app/s-form-component)**
2. [Features](#readme-features)
3. [Install](#readme-install)
4. [Get Started](#readme-get-started)
5. [SASS API](doc/sass)
6. [Browsers support](#readme-browsers-support)
7. [Contribute](#readme-contribute)
8. [Who are Coffeekraken?](#readme-who-are-coffeekraken)
9. [Licence](#readme-license)

<a name="readme-features"></a>
## Features

1. Styling for `input`, `textarea` and `select`
2. `.form-group` support to display multiple inputs on the same line
3. `.form-addon` to display addons aside a form input
4. Colored version of each `input`, `textarea` and `select` available

<a name="readme-install"></a>
## Install

```
npm install coffeekraken-s-form-component --save
```

<a name="readme-get-started"></a>
## Get Started

First, [import and init sugar](https://github.com/coffeekraken/sugar) into your project.

Then, import the component into your scss file like so:

```scss
@import 'node_modules/coffeekraken-s-form-component/index';
```

Then generate the classes using the provided mixins like so:

```scss
@include s-form-classes(
	$colors: default primary secondary
);
```

Then simply use it inside your html like so:

```html
<div class="form-group m-b">
	<input type="text" name="firstname" class="form-input" placeholder="Firstname" />
</div>
<div class="form-group m-b">
	<textarea class="form-textarea" name="message" placeholder="Your message here..."></textarea>
</div>
<div class="form-group m-b">
	<select class="form-select" name="gender">
		<option value="">Choose a gender</option>
		<option value="male">Male</option>
		<option value="female">Female</option>
	</select>
</div>
```

<a id="readme-browsers-support"></a>
## Browsers support

| <img src="https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/edge.png" alt="IE / Edge" width="16px" height="16px" /></br>IE / Edge | <img src="https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/firefox.png" alt="Firefox" width="16px" height="16px" /></br>Firefox | <img src="https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/chrome.png" alt="Chrome" width="16px" height="16px" /></br>Chrome | <img src="https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/safari.png" alt="Safari" width="16px" height="16px" /></br>Safari |
| --------- | --------- | --------- | --------- |
| IE11+ | last 2 versions| last 2 versions| last 2 versions

> As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

> The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the [corresponding polyfill](https://www.webcomponents.org/polyfills).

<a id="readme-contribute"></a>
## Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day.
To do so, you have several possibilities:

1. [Share the love ❤️](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-share-the-love)
2. [Declare issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-declare-issues)
3. [Fix issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-fix-issues)
4. [Add features](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-add-features)
5. [Build web component](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-build-web-component)

<a id="readme-who-are-coffeekraken"></a>
## Who are Coffeekraken

We try to be **some cool guys** that build **some cool tools** to make our (and yours hopefully) **every day life better**.  

#### [More on who we are](https://github.com/Coffeekraken/coffeekraken/blob/master/who-are-we.md)

<a id="readme-license"></a>
## License

The code is available under the [MIT license](LICENSE.txt). This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to [contribute](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md) instead of sharing your frustrations on social networks like an asshole...

---
_Source: https://npm.io/package/coffeekraken-s-form-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
