Semantic UI
ctrl+k
Enter a search term above to see results...
On This Page
getDefinition()
Documentation Generation
Methods for generating documentation definitions with code examples from specs.
getDefinition()
Generates documentation definition with code examples. Returns structured object with types, states, variations, and working code examples for each.
Syntax
reader.getDefinition(options)Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| plural | boolean | this.plural | Generate plural definition |
| minUsageLevel | number | undefined | Filter by minimum usage level |
| dialect | string | this.dialect | HTML dialect for examples |
Returns
| Property | Type | Description |
|---|---|---|
| content | Array | Content/slot examples |
| types | Array | Type examples |
| states | Array | State examples |
| variations | Array | Variation examples |
| settings | Array | Setting examples |
Each array contains objects with:
| Property | Type | Description |
|---|---|---|
| title | string | Section title |
| description | string | Section description |
| examples | Array | Code examples with component metadata |
Usage
import { SpecReader } from '@semantic-ui/specs';import buttonSpec from './button.spec.js';
const reader = new SpecReader(buttonSpec);const definition = reader.getDefinition();
// Use for documentation generationdefinition.variations.forEach(variation => { console.log(variation.title); variation.examples.forEach(example => { console.log(example.code); });});