@praxisui/rich-content 8.0.0-beta.105 → 8.0.0-beta.106

package/README.md

@@ -1,4 +1,59 @@
-# PraxisRichContent
+# @praxisui/rich-content
+
+Rich content rendering and authoring primitives for Praxis UI surfaces,
+including semantic blocks, governed action surfaces and page-builder
+integration.
+
+## Documentation
+
+- Official documentation: https://praxisui.dev/docs/components
+- Quickstart reference app: https://github.com/codexrodrigues/praxis-ui-quickstart
+- Live Praxis UI demo: https://praxis-ui-4e602.web.app
+
+## Install
+
+```bash
+npm i @praxisui/rich-content@beta
+```
+
+Peer dependencies:
+- `@angular/core` `^21.0.0`
+- `@angular/common` `^21.0.0`
+- `@angular/forms` `^21.0.0`
+- `@praxisui/core` `^8.0.0-beta.106`
+- `rxjs` `~7.8.0`
+
+## When to use
+
+- Render portable `RichContentDocument` JSON inside Praxis runtime surfaces
+- Provide page-builder widgets for semantic content blocks
+- Reuse the canonical rich-content editor instead of building local JSON editors
+- Validate rich documents before persistence with `validateRichContentDocument()`
+
+## Minimal standalone renderer
+
+```ts
+import { Component } from '@angular/core';
+import { PraxisRichContent } from '@praxisui/rich-content';
+import type { RichContentDocument } from '@praxisui/core';
+
+@Component({
+  selector: 'app-rich-content-preview',
+  standalone: true,
+  imports: [PraxisRichContent],
+  template: `<praxis-rich-content [document]="document" />`,
+})
+export class RichContentPreviewComponent {
+  document: RichContentDocument = {
+    kind: 'praxis.rich-content',
+    version: '1.0.0',
+    nodes: [
+      { type: 'text', text: 'Governed rich content' },
+      { type: 'badge', label: 'canonical' },
+    ],
+  };
+}
+```
 
 `PraxisRichContent` renders metadata-driven rich nodes and blocks used by Praxis
 components such as table renderers, list metrics and compact status surfaces.
@@ -305,63 +360,3 @@ Supported inline variables:
 - `--prx-rich-content-inline-align-items`, default `center`
 - `--prx-rich-content-inline-flex-wrap`, default `nowrap`
 - `--prx-rich-content-inline-gap`, default `6px`
-
-## Code scaffolding
-
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
-
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
-```
-
-## Building
-
-To build the library, run:
-
-```bash
-ng build praxis-rich-content
-```
-
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
-
-### Publishing the Library
-
-Once the project is built, you can publish your library by following these steps:
-
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/praxis-rich-content
-   ```
-
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
-
-## Running unit tests
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
-```
-
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@praxisui/rich-content",
-  "version": "8.0.0-beta.105",
+  "version": "8.0.0-beta.106",
+  "description": "Rich content rendering and authoring primitives for Praxis UI surfaces, including semantic blocks and page-builder integration.",
   "peerDependencies": {
     "@angular/common": "^21.0.0",
     "@angular/core": "^21.0.0",
-    "@praxisui/core": "^8.0.0-beta.105",
+    "@praxisui/core": "^8.0.0-beta.106",
     "@angular/forms": "^21.0.0",
     "rxjs": "~7.8.0"
   },