# @swrs/skrw-js

> js / css package for skrw authentication and CMS Rails engine

Latest version **2.0.2** (published 2021-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @swrs/skrw-js
pnpm add @swrs/skrw-js
yarn add @swrs/skrw-js
bun add @swrs/skrw-js
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2021-02-11 |
| First published | 2019-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 707.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | swrs |
| Maintainers | swrs |

## Links

- npm: https://www.npmjs.com/package/@swrs/skrw-js
- Repository: https://gitlab.com/swrs/skrw-js
- npm.io page: https://npm.io/package/@swrs/skrw-js

## Recent versions

- 2.0.2 (latest) — 2021-02-11
- 1.1.3 — 2019-09-27
- 1.1.2 — 2019-08-29
- 1.1.1 — 2019-08-28
- 1.1.0 — 2019-08-21
- 1.0.13 — 2019-08-15
- 1.0.12 — 2019-08-15
- 1.0.11 — 2019-08-14
- 1.0.10 — 2019-08-14
- 1.0.9 — 2019-08-14
- 1.0.8 — 2019-08-14
- 1.0.7 — 2019-08-14
- 1.0.6 — 2019-08-14
- 1.0.5 — 2019-08-14
- 1.0.4 — 2019-08-13
- … 4 more at https://npm.io/package/@swrs/skrw-js/versions

## README

# skrw-js

*skrw-js* is a package of JS and styles for the *Ruby on Rails* engine [*skrw*](https://gitlab.com/swrs/skrw).

## Installation

Add *skrw-js* to dependencies:

```bash
$ yarn add https://gitlab.com/swrs/skrw-js.git
```

Import and start in your application:

```js
// e.g. application.js or admin.js
import Skrw from "@swrs/skrw-js"
import "@swrs/skrw-js/dist/index.css"

const skrw = new Skrw()
skrw.start()
```

## Stimulus Controllers

- [Tags](#tags-controller)
- [Markdown Editor](#mde-controller)

<a name="tags-controller"></a>
### Skrw Tags Controller

The `skrw-tags` controller is used on text input fields to provide an interface for comma-seperated tag lists with optional suggestions using [yairEO/tagify](https://github.com/yairEO/tagify). 

Usage:

```html
<!-- simple tags input -->
<input type="text" value="apple, pear, banana" data-controller="skrw-tag">

<!-- tags input fetching suggestions from whitelistUrl -->
<input type="text" value="apple, pear, banana" data-controller="skrw-tag" data-skrw-tags-whitelist-url="/tags/index.json">
```

- `data-skrw-tags-whitelist-url` (string)
  Url for a `application/json` request to fetch whitelist of tags. Expected response format is `[{ value: "apple" }, { value: "banana" }, …]`

- `data-skrw-tags-enforce-whitelist` (boolean, default = false)
  ONLY allow whitelisted tags (requires fetched whitelist from `whitelistUrl`).

<a name="mde-controller"></a>
### Skrw Markdown Editor Controller

The `skrw-mde` controller is used on `textarea` to create a markdown editor using [EasyMDE – Markdown Editor](https://github.com/Ionaru/easy-markdown-editor). 

Usage:

```html
<!-- basic mde editor with full toolbar -->
<textarea data-controller="skrw-mde"></textarea>

<!-- mde editor with customized toolbar -->
<textarea data-controller="skrw-mde" data-skrw-mde-toolbar="link, italic, bold"></textarea>
```

- `data-skrw-mde-toolbar` (comma-seperated list)
  Comma-seperated list to set the available tools in the toolbar, see [EasyMDE](https://github.com/Ionaru/easy-markdown-editor) for all available toolbar options.

## Development

To develop *skrw-js* while running *Rails*'s *Webpacker* it might be helpful to link to the local repository of *skrw-js* and watch for changes in your application's `node_modules`:

```bash
yarn add link:/path/to/skrw-js
```

```js
// config/webpack/development.js
process.env.NODE_ENV = process.env.NODE_ENV || 'development'
const environment = require('./environment')
environment.config.set("devServer.watchOptions.ignored", "/node_modules\/(?!@swrs).*/")

module.exports = environment.toWebpackConfig()
```

---
_Source: https://npm.io/package/@swrs/skrw-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._