Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remcohaszing/monaco-tailwindcss
Tailwindcss intellisense support in Monaco editor
https://github.com/remcohaszing/monaco-tailwindcss
monaco monaco-editor tailwind tailwind-css tailwindcss
Last synced: about 7 hours ago
JSON representation
Tailwindcss intellisense support in Monaco editor
- Host: GitHub
- URL: https://github.com/remcohaszing/monaco-tailwindcss
- Owner: remcohaszing
- License: mit
- Created: 2022-04-01T15:52:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T11:03:13.000Z (11 months ago)
- Last Synced: 2024-05-02T05:14:23.146Z (5 months ago)
- Topics: monaco, monaco-editor, tailwind, tailwind-css, tailwindcss
- Language: TypeScript
- Homepage: https://monaco-tailwindcss.js.org
- Size: 513 KB
- Stars: 71
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Monaco Tailwindcss
[](https://github.com/remcohaszing/monaco-tailwindcss/actions/workflows/ci.yaml)
[](https://www.npmjs.com/package/monaco-tailwindcss)
[](https://prettier.io)
[](https://monaco-tailwindcss.js.org)
[](https://app.netlify.com/sites/monaco-tailwindcss/deploys)
[Tailwindcss](https://tailwindcss.com) integration for
[Monaco editor](https://microsoft.github.io/monaco-editor).
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [`monaco-tailwindcss`](#monaco-tailwindcss-1)
- [`monaco-tailwindcss/tailwindcss.worker`](#monaco-tailwindcsstailwindcssworker)
- [Related projects](#related-projects)
- [Showcase](#showcase)
- [License](#license)
## Installation
```sh
npm install monaco-tailwindcss
```
## Usage
Import `monaco-tailwindcss` and configure it before an editor instance is created.
```typescript
import * as monaco from 'monaco-editor'
import { configureMonacoTailwindcss, tailwindcssData } from 'monaco-tailwindcss'
monaco.languages.css.cssDefaults.setOptions({
data: {
dataProviders: {
tailwindcssData
}
}
})
configureMonacoTailwindcss(monaco)
monaco.editor.create(document.createElement('editor'), {
language: 'html',
value: `
`
})
```
Also make sure to register the web worker. When using Webpack 5, this looks like the code below.
Other bundlers may use a different syntax, but the idea is the same. Languages you don’t used can be
omitted.
```js
window.MonacoEnvironment = {
getWorker(moduleId, label) {
switch (label) {
case 'editorWorkerService':
return new Worker(new URL('monaco-editor/esm/vs/editor/editor.worker', import.meta.url))
case 'css':
case 'less':
case 'scss':
return new Worker(new URL('monaco-editor/esm/vs/language/css/css.worker', import.meta.url))
case 'handlebars':
case 'html':
case 'razor':
return new Worker(
new URL('monaco-editor/esm/vs/language/html/html.worker', import.meta.url)
)
case 'json':
return new Worker(
new URL('monaco-editor/esm/vs/language/json/json.worker', import.meta.url)
)
case 'javascript':
case 'typescript':
return new Worker(
new URL('monaco-editor/esm/vs/language/typescript/ts.worker', import.meta.url)
)
case 'tailwindcss':
return new Worker(new URL('monaco-tailwindcss/tailwindcss.worker', import.meta.url))
default:
throw new Error(`Unknown label ${label}`)
}
}
}
```
## API
This package exposes two exports. One to setup the main logic, another to customize the Tailwind
configuration in the worker.
### `monaco-tailwindcss`
#### `configureMonacoTailwindcss(monaco, options?)`
Configure `monaco-tailwindcss`.
**Arguments**:
- `monaco`: The `monaco-editor` module. (`object`)
- `options`: An object with the following properties:
- `languageSelector`: The language ID or IDs to which to apply `monaco-unified`. (`string` |
`string[]`, optional, default: `['css', 'javascript', 'html', 'mdx', 'typescript']`)
- `tailwindConfig`: The tailwind configuration to use. This may be either the Tailwind
configuration object, or a string that gets processed in the worker. (`object` | `string`,
optional)
**Returns**: A disposable with the following additional properties:
- `setTailwindConfig(tailwindConfig)`: Update the current Tailwind configuration.
- `generateStylesFromContent(css, content)`: Generate a CSS string based on the current Tailwind
configuration.
#### `tailwindcssData`
This data can be used with the default Monaco CSS support to support tailwind directives. It will
provider hover information from the Tailwindcss documentation, including a link.
### `monaco-tailwindcss/tailwindcss.worker`
#### `initialize(options)`
Setup the Tailwindcss worker using a customized configuration.
**Arguments**:
- `options`: An object with the following properties:
- `prepareTailwindConfig(tailwindConfig)` A functions which accepts the Tailwind configuration
passed from the main thread, and returns a valid Tailwind configuration.
## Related projects
- [monaco-unified](https://monaco-unified.js.org)
- [monaco-yaml](https://monaco-yaml.js.org)
## Showcase
- [Motif](https://motif.land) uses `monaco-tailwindcss` to provide Tailwindcss intellisense in their
MDX based content editor.
## License
[MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)