@codeauradev/ngx-wind-editor 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ngx-wind-editor contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,90 @@
-# Temporary Holding Version
+# @codeauradev/ngx-wind-editor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+WYSIWYG HTML editor for Angular 22. The chrome is Tailwind CSS v4, and it follows a `dark` class on an ancestor for dark mode.
+
+```html
+<wind-editor [(html)]="html" placeholder="Write something…" />
+```
+
+```ts
+import { Component, signal } from '@angular/core';
+import { WindEditor } from '@codeauradev/ngx-wind-editor';
+
+@Component({
+  selector: 'app-note',
+  imports: [WindEditor],
+  template: `<wind-editor [(html)]="html" />`,
+})
+export class Note {
+  readonly html = signal('<p>Start writing.</p>');
+}
+```
+
+`[(html)]` is the serialized document.
+
+## Install
+
+```bash
+npm install @codeauradev/ngx-wind-editor
+```
+
+Peer: `@angular/core` `^22`. Tailwind CSS v4 is optional and styles the toolbar.
+
+```css
+@import "tailwindcss";
+@source "../node_modules/@codeauradev/ngx-wind-editor";
+@custom-variant dark (&:where(.dark, .dark *));
+```
+
+`@source` lets Tailwind see the utility classes in the component. Document typography and the placeholder ship in the component stylesheet, so the page still reads if you skip Tailwind. Put `class="dark"` on an ancestor to switch the document to dark.
+
+## Toolbar
+
+`toolbar` picks which buttons appear. A preset name, or a list of ids in the order you want:
+
+```html
+<wind-editor [(html)]="html" toolbar="writing" />
+<wind-editor [(html)]="html" [toolbar]="['bold', 'italic', 'link', 'bullet']" />
+```
+
+| Preset | Buttons |
+| --- | --- |
+| `full` | Every button. This is the default. |
+| `writing` | Paragraph, headings, bold, italic, link, lists, quote, undo, redo |
+| `basic` | Bold, italic, underline, strike, link, lists, undo, redo |
+| `minimal` | Bold, italic, link |
+
+Ids: `paragraph`, `h1`, `h2`, `bold`, `italic`, `underline`, `strike`, `code`, `link`, `bullet`, `ordered`, `quote`, `codeblock`, `rule`, `image`, `clear`, `undo`, `redo`, `source`. Unknown ids are ignored. `[showToolbar]="false"` hides the bar entirely.
+
+`/` at the start of an empty block opens the block menu. Arrow keys move, Enter applies, Escape cancels. In a code block, Enter inserts a newline and Ctrl/Cmd+Enter starts a paragraph under it.
+
+| Shortcut | Action |
+| --- | --- |
+| Mod+B / I / U / E | Bold, italic, underline, inline code |
+| Mod+Shift+X | Strikethrough |
+| Mod+K | Link |
+| Mod+Z / Mod+Shift+Z | Undo / redo |
+
+Mod is Cmd on macOS and Ctrl elsewhere.
+
+## HTML
+
+The editor reads and writes a fixed subset: `p`, `h1`–`h3`, `blockquote`, `ul`, `ol`, `li`, `pre`, `code`, `strong`, `em`, `u`, `s`, `a`, `br`, `hr`, `img`. `javascript:` URLs are dropped. Lists are flat.
+
+Set the model and the editor replaces its document. Edits write back.
+
+## Readonly
+
+```html
+<wind-editor [html]="published" [readonly]="true" [showToolbar]="false" />
+```
+
+## Build this package
+
+```bash
+npm install
+npm test
+npm run build
+```
+
+Publish `dist/`. It is an Angular Package Format build (partial compilation).