# @dojo/parade

> A library to show off your widget library.

Latest version **2.0.0** (published 2021-07-30) · 0 weekly downloads

## Install

```sh
npm install @dojo/parade
pnpm add @dojo/parade
yarn add @dojo/parade
bun add @dojo/parade
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-07-30 |
| First published | 2019-11-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 4.6 MB |
| Known vulnerabilities | 0 (+13 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | dylans, agubler, matt-gadd, tomdye, bitpshr, rorticus |

## Links

- npm: https://www.npmjs.com/package/@dojo/parade
- npm.io page: https://npm.io/package/@dojo/parade

## Dependencies (13)

- [tslib](https://npm.io/package/tslib.md) ~1.9.1
- [postcss](https://npm.io/package/postcss.md) 7.0.21
- [prismjs](https://npm.io/package/prismjs.md) 1.17.1
- [unified](https://npm.io/package/unified.md) 8.4.1
- [ts-morph](https://npm.io/package/ts-morph.md) 4.2.0
- [cldr-data](https://npm.io/package/cldr-data.md) 36.0.0
- [remark-parse](https://npm.io/package/remark-parse.md) 7.0.1
- [remark-rehype](https://npm.io/package/remark-rehype.md) 5.0.0
- [canonical-path](https://npm.io/package/canonical-path.md) 1.0.0
- [rehype-stringify](https://npm.io/package/rehype-stringify.md) 6.0.0
- [remark-sectionize](https://npm.io/package/remark-sectionize.md) ^1.1.0
- [rehype-add-classes](https://npm.io/package/rehype-add-classes.md) ^1.0.0
- [@fortawesome/fontawesome-free](https://npm.io/package/@fortawesome/fontawesome-free.md) 5.15.3

## Recent versions

- 2.0.0 (latest) — 2021-07-30
- 2.0.0-rc.4 — 2021-07-30
- 2.0.0-rc.3 — 2021-07-30
- 2.0.0-rc.2 — 2021-07-30
- 2.0.0-rc.1 — 2021-07-30
- 1.0.1 — 2021-03-24
- 1.0.0 — 2020-05-27
- 1.0.0-rc.3 — 2020-04-27
- 1.0.0-rc.2 — 2020-04-24
- 1.0.0-rc.1 — 2020-04-24
- 1.0.0-beta.1 — 2020-04-17
- 0.0.15 — 2020-04-08
- 0.0.14 — 2020-04-07
- 0.0.13 — 2020-03-20
- 0.0.12 — 2020-03-20
- … 11 more at https://npm.io/package/@dojo/parade/versions

## 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
};
```

---
_Source: https://npm.io/package/@dojo/parade · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._