# @techstacker/tse-italic-plugin

> SlateJS italic mark plugin.

Latest version **5.2.0-alpha.273b0e7e** (published 2018-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @techstacker/tse-italic-plugin
pnpm add @techstacker/tse-italic-plugin
yarn add @techstacker/tse-italic-plugin
bun add @techstacker/tse-italic-plugin
```

## 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 | 5.2.0-alpha.273b0e7e |
| Published | 2018-10-29 |
| First published | 2018-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 266 |
| Author | Nossas |
| Maintainers | kandelborg, techstacker-owner |
| Keywords | slate, rich-text, editor, react, slate-plugins |

## Links

- npm: https://www.npmjs.com/package/@techstacker/tse-italic-plugin
- Repository: https://github.com/nossas/slate-editor
- Issues: https://github.com/nossas/slate-editor/issues
- npm.io page: https://npm.io/package/@techstacker/tse-italic-plugin

## Dependencies (5)

- [react](https://npm.io/package/react.md) ^16.2.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [react-fontawesome](https://npm.io/package/react-fontawesome.md) ^1.6.1
- [@slate-editor/utils](https://npm.io/package/@slate-editor/utils.md) ^5.0.0
- [@slate-editor/components](https://npm.io/package/@slate-editor/components.md) ^5.0.0

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 5.2.0-alpha.273b0e7e (latest) — 2018-10-29

## README

<div align="center">
  <a href="https://www.en.nossas.org" rel="noopener" target="_blank">
    <img
      width="200"
      src="https://s3.amazonaws.com/hub-central/uploads/logo-nossas-20170517185909.svg"
      alt="Nossas logo"
      title="Nossas"
    />
  </a>
</div>
<div align="center">
  <img
    src="https://www.psdmockups.com/wp-content/uploads/2016/07/slatejs-520x292.jpg"
    alt="Nossas Cidades logo"
    title="Nossas Cidades"
    height="50"
  />
</div>

<h1 align="center">@slate-editor/italic-plugin</h1>

<div align="center">

[SlateJS](https://github.com/ianstormtaylor/slate) italic plugin.

[![npm package](https://img.shields.io/npm/v/@slate-editor/italic-plugin.svg?maxAge=60)](https://www.npmjs.com/package/@slate-editor/italic-plugin)
[![npm downloads](https://img.shields.io/npm/dt/@slate-editor/italic-plugin.svg?maxAge=60)](https://www.npmjs.com/package/@slate-editor/italic-plugin)

</div>

## Installation
The **@slate-editor/italic-plugin** is available as an [npm package](https://www.npmjs.com/package/@slate-editor/italic-plugin).

```
yarn add @slate-editor/italic-plugin
```

## Usage
Here is a quick example to get you started:

```js
import React from 'react'
import { SlateEditor, SlateToolbar, SlateContent } from 'slate-editor'
import { ItalicPlugin, ItalicButton } from '@slate-editor/italic-plugin'

const plugins = [
  ItalicPlugin()
]

const SlateRichTextEditor = () => (
  <SlateEditor plugins={plugins}>
    <SlateToolbar>
      <ItalicButton />
    </SlateToolbar>

    <SlateContent />
  </SlateEditor>
)

export default SlateRichTextEditor
```

## Keyboard Shortcut

| OS                       | Shortcut   |
|--------------------------|------------|
| ![Apple Logo][apple]     | `⌘`+`i`    |
| ![Windows Logo][windows] | `ctrl`+`i` |

## API

| Name                   | Description                                                                 |
|------------------------|-----------------------------------------------------------------------------|
| ItalicMark             | Component that holds the html that will wrap the content with italic style. |
| ItalicKeyboardShortcut | Keyboard shortcut file that manipulates `onKeyDown` event inside SlateJS.   |
| ItalicUtils            | Generic file that holds the util common functions.                          |
| ItalicButton           | Button component that have behaviour to wrap content with italic style.     |

## TODO

- Make keyboard shortcut accepts customization

[apple]: https://cdn2.iconfinder.com/data/icons/designer-skills/128/apple-ios-system-platform-os-mac-linux-48.png
[windows]: https://cdn2.iconfinder.com/data/icons/designer-skills/128/windows-48.png

---
_Source: https://npm.io/package/@techstacker/tse-italic-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._