@ui-autotools/registry v5.0.0

Metadata registry

allows creating/retriving code metdata descriptions.

API

describe

creates/retrieves a metadata description object

arguments:

returns:

ReactDescription, ClassDescription, FunctionDescription or GeneralDescription

GeneralDescription

allows reading/writing the different meta-data fields.

API

setTitle

sets title of entity

arguments:

setDescription

sets description of entity

arguments:

addDocumentation

adds documentation in markdown format to entity

arguments:

setJSONSchema

sets JSONSchema of entity

arguments:

addBrowserTests

adds browser tests to entity

arguments:

myDesc.addBrowserTests('accesability' ()=>import('./accesability.spec.ts')

ReactDescription

react description adds some extra field to the general description

setReactType

sets type of react entity

arguments:

addSimulation

adds prop simulation to component

arguments:

addSimulationPropValue

adds cross cutting prop to all component simulations

arguments:

addStateSimulation

adds state simulation to component, usefull for getting the component into different visual states without user interaction. i.e. open in a drop down

arguments:

ClassDescription

addConstructorArgumentsSimulation

adds constructor arguments simulation to class

arguments:

FunctionDescription

addArgumentsSimulation

adds arguments simulation to function

arguments: