https://github.com/chialab/typos

Typing utilities for WYSIWYG editors.
https://github.com/chialab/typos

Last synced: about 2 months ago
JSON representation

Typing utilities for WYSIWYG editors.

• Host: GitHub
• URL: https://github.com/chialab/typos
• Owner: chialab
• License: mit
• Created: 2022-12-05T08:46:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-09T09:53:09.000Z (12 months ago)
• Last Synced: 2024-09-16T13:34:11.500Z (4 months ago)
• Language: TypeScript
• Size: 207 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  Typos • Typing utilities for WYSIWYG editors.





    



---

## Get the library

### NPM

Install via NPM or Yarn:

```

npm i @chialab/typos

```

```

yarn add @chialab/typos

```

### CDN

```js

import { fixQuotes } from 'https://unpkg.com/@chialab/typos?module';

```

## Usage

### TinyMCE

Use **Typos** as plugin for [TinyMCE](https://www.tiny.cloud/):

```ts

import tinymce from 'tinymce/tinymce';

import { tinymcePlugin } from '@chialab/typos';

tinymcePlugin(tinymce);

tinymce.init({

  selector: 'textarea',

  plugins: 'typos',

  toolbar: 'fixQuotes',

});

```

---

## Development

Install the dependencies

```

yarn

```

Run the `dev` script to debug the library:

```

yarn dev

```

Run the `build` script for distribution:

```

yarn build

```

This will generate the ESM bundle in the `dist` folder and declaration files in the `types` folder.

---

## License

**Typos** is released under the [MIT](https://github.com/chialab/typos/blob/main/LICENSE) license.