@ng-prism/core 21.7.0 → 21.7.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 +7 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,16 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
Lightweight, Angular-native component showcase tool. Annotate components with `@Showcase` — no separate story files needed.
|
|
4
4
|
|
|
5
|
-
[](https://angular.dev)
|
|
6
6
|
[](https://www.typescriptlang.org)
|
|
7
7
|
[](./LICENSE)
|
|
8
8
|
|
|
9
|
+
**[Live Demo](https://dyingangel666.github.io/ng-prism/demo/)** · **[Documentation](https://dyingangel666.github.io/ng-prism/)**
|
|
10
|
+
|
|
9
11
|
## Features
|
|
10
12
|
|
|
11
13
|
- **Zero-config discovery** — TypeScript Compiler API scans your library at build time
|
|
12
14
|
- **Signal-native** — works with `input()` / `output()` signals
|
|
13
15
|
- **Directive support** — showcase directives with configurable host elements
|
|
14
|
-
- **Plugin architecture** — JSDoc, A11y, Figma, Performance, Box Model, Coverage
|
|
16
|
+
- **Plugin architecture** — JSDoc, A11y, Figma, Performance, Box Model, Coverage
|
|
15
17
|
- **Live Controls** — auto-generated input controls with type-aware editors
|
|
16
18
|
- **Code Snippets** — live-updating Angular template snippets per variant
|
|
17
19
|
- **Component Pages** — free-form demo pages for complex components
|
|
@@ -82,14 +84,9 @@ export default defineConfig({
|
|
|
82
84
|
|
|
83
85
|
theme: {
|
|
84
86
|
'--prism-primary': '#00a67e',
|
|
85
|
-
'--prism-bg': '#ffffff',
|
|
86
87
|
'--prism-font-sans': "'Inter', sans-serif",
|
|
87
88
|
},
|
|
88
89
|
|
|
89
|
-
ui: {
|
|
90
|
-
header: MyCustomHeaderComponent,
|
|
91
|
-
},
|
|
92
|
-
|
|
93
90
|
appProviders: [
|
|
94
91
|
provideAnimationsAsync(),
|
|
95
92
|
provideHttpClient(),
|
|
@@ -122,7 +119,6 @@ export class TooltipDirective { ... }
|
|
|
122
119
|
For complex components that need template projections or mock data:
|
|
123
120
|
|
|
124
121
|
```typescript
|
|
125
|
-
// Register in main.ts
|
|
126
122
|
providePrism(PRISM_RUNTIME_MANIFEST, config, {
|
|
127
123
|
componentPages: [
|
|
128
124
|
{ title: 'Table Demo', category: 'Data', component: TableDemoPage },
|
|
@@ -135,11 +131,9 @@ Link to a `@Showcase`-decorated component for combined API docs + custom renderi
|
|
|
135
131
|
```typescript
|
|
136
132
|
@Showcase({
|
|
137
133
|
title: 'Table',
|
|
138
|
-
renderPage: 'Table Demo',
|
|
134
|
+
renderPage: 'Table Demo',
|
|
139
135
|
variants: [{ name: 'Default', inputs: { height: '400px' } }],
|
|
140
136
|
})
|
|
141
|
-
@Component({ selector: 'my-table' })
|
|
142
|
-
export class TableComponent { ... }
|
|
143
137
|
```
|
|
144
138
|
|
|
145
139
|
## Official Plugins
|
|
@@ -154,18 +148,12 @@ export class TableComponent { ... }
|
|
|
154
148
|
|
|
155
149
|
> **Note:** Accessibility auditing (axe-core) is built into ng-prism core — no plugin needed.
|
|
156
150
|
|
|
157
|
-
## Documentation
|
|
158
|
-
|
|
159
|
-
Full documentation with API reference, plugin guide, and advanced configuration:
|
|
160
|
-
|
|
161
|
-
**[ng-prism Documentation](https://your-org.github.io/ng-prism/)**
|
|
162
|
-
|
|
163
151
|
## Requirements
|
|
164
152
|
|
|
165
153
|
- Angular >= 19
|
|
166
154
|
- TypeScript >= 5.9
|
|
167
|
-
- Components must use `input()` / `output()` signals
|
|
155
|
+
- Components must use `input()` / `output()` signals
|
|
168
156
|
|
|
169
157
|
## License
|
|
170
158
|
|
|
171
|
-
MIT
|
|
159
|
+
[MIT](./LICENSE)
|