@itguy614/clean-ui 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ and overridable at every level via CSS custom properties.
|
|
|
17
17
|
- **Accessible first** — WCAG AA contrast targets, ARIA attributes, keyboard navigation, focus management.
|
|
18
18
|
- **TypeScript** — full type definitions; shared `CuiColor` / `CuiSize` / `CuiRounded` prop types across components.
|
|
19
19
|
- **Tailwind CSS v4 compatible** — color scales registered via `@theme` so Tailwind utilities work alongside the components.
|
|
20
|
-
- **Tree-shakeable ESM**
|
|
20
|
+
- **Tree-shakeable, per-module ESM** — Vue is the only peer dependency. (ESM-only as of 1.0.)
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
23
23
|
|
|
@@ -107,6 +107,36 @@ Every color, radius, and typography value is a `--cui-*` custom property. Overri
|
|
|
107
107
|
}
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
+
## Markdown editor
|
|
111
|
+
|
|
112
|
+
Need a markdown editor? The companion package
|
|
113
|
+
[**`@itguy614/clean-ui-editor`**](https://www.npmjs.com/package/@itguy614/clean-ui-editor)
|
|
114
|
+
is a CodeMirror 6 editor themed with clean-ui's tokens — WYSIWYG (hidden syntax markers) and
|
|
115
|
+
source modes, a declarative plugin API, and an optional safe HTML renderer. It has a heavier
|
|
116
|
+
dependency graph, so it ships as a separate, lazily-loadable package rather than in the core:
|
|
117
|
+
|
|
118
|
+
```sh
|
|
119
|
+
npm install @itguy614/clean-ui-editor
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
```vue
|
|
123
|
+
<script setup lang="ts">
|
|
124
|
+
import { ref, defineAsyncComponent } from "vue";
|
|
125
|
+
import "@itguy614/clean-ui-editor/styles";
|
|
126
|
+
|
|
127
|
+
const CuiMarkdownEditor = defineAsyncComponent(() =>
|
|
128
|
+
import("@itguy614/clean-ui-editor").then((m) => m.CuiMarkdownEditor),
|
|
129
|
+
);
|
|
130
|
+
const content = ref("# Hello");
|
|
131
|
+
</script>
|
|
132
|
+
|
|
133
|
+
<template>
|
|
134
|
+
<CuiMarkdownEditor v-model="content" />
|
|
135
|
+
</template>
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
See the [editor README](../clean-ui-editor/README.md) for modes, plugins, and rendering.
|
|
139
|
+
|
|
110
140
|
## Documentation
|
|
111
141
|
|
|
112
142
|
Full component reference, props, and live examples: **https://itguy614.github.io/clean-ui/**
|
package/dist/version.js
CHANGED
package/package.json
CHANGED