@dojo/parade
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@dojo/parade

A library to show off your widget library.

  • Show running demos
  • Syntax highlighted example code
  • Auto documented widget properties
  • Auto documented theme class hooks
  • Run on codesandbox
  • Run unit tests

screenshot

Compatibility

Each major release of Dojo Parade is compatible with a specific major version of the rest of the Dojo framework:

Parade Version Dojo Version
1.*.* 7.*.*

Usage

npm install @dojo/parade

.dojorc

{
	"extends": "./node_modules/@dojo/parade/parade.json"
}

main.tsx

import parade from '@dojo/parade';

// import your parade config
import config from './config';

parade({ config });

Example global config:

config.tsx

import dojoTheme from '@dojo/themes/dojo';
import '@dojo/themes/dojo/index.css';

import BasicAccordion from './widgets/accordion/Basic';
import BasicButton from './widgets/button/Basic';
import DisabledSubmit from './widgets/button/DisabledSubmit';
import ToggleButton from './widgets/button/ToggleButton';

const tests = (require as any).context('./', true, /\.spec\.ts(x)?$/);

export default {
  header: 'My Widget Library',
  codesandbox: {},
  tests,
  themes: [ dojoTheme ]

Example local config:

AccordionBasic.example.tsx

import dojoTheme from '@dojo/themes/dojo';
import '@dojo/themes/dojo/index.css';

import AccordionBasic from './widgets/accordion/Basic';

export default {
	module: AccordionBasic,
	overview: true
};

Readme

Keywords

none

Package Sidebar

Install

npm i @dojo/parade

Weekly Downloads

4

Version

2.0.0

License

none

Unpacked Size

4.81 MB

Total Files

113

Last publish

Collaborators

  • dylans
  • agubler
  • matt-gadd
  • tomdye
  • rorticus