https://github.com/dojo/parade

https://github.com/dojo/parade

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dojo/parade
• Owner: dojo
• Created: 2019-11-27T11:28:11.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T15:22:19.000Z (about 1 year ago)
• Last Synced: 2024-04-09T21:10:43.715Z (7 months ago)
• Language: TypeScript
• Size: 4.11 MB
• Stars: 3
• Watchers: 18
• Forks: 11
• Open Issues: 22
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @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](/screenshot.png?raw=true '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

```bash

npm install @dojo/parade

```

#### **`.dojorc`**

```json

{

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

}

```

#### **`main.tsx`**

```tsx

import parade from '@dojo/parade';

// import your parade config

import config from './config';

parade({ config });

```

### Example global config:

#### **`config.tsx`**

```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`**

```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

};

```