Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Commit

Permalink
feat: support any npm package exporting react components (#613)
Browse files Browse the repository at this point in the history
* feat: support any npm package exporting react components

* docs: reflect lib changes in docs

* fix: consider prettier format
  • Loading branch information
marionebl authored and tilmx committed Sep 19, 2018
1 parent 4bd8830 commit 9412309
Show file tree
Hide file tree
Showing 8 changed files with 619 additions and 89 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ There is no such thing as out-dated and static PNG screens, as the current versi
* **Language**: TypeScript
* **View Library**: React
* **Styleguide**: [patternplate](https://patternplate.github.io/)
* Must be a valid NPM package exporting components via a central entry point

> :information_source: We plan to support more technologies and setups in the future.
Expand All @@ -76,9 +76,9 @@ There is no such thing as out-dated and static PNG screens, as the current versi
* **Language**: TypeScript
* **View Library**: React

* Must be a valid `patternplate` pattern (have `demo.tsx`, `pattern.json`)
* Must be reachable from the central package entry point
* Must be exported via `export`
* Must by typed as `React.SFC`, `React.ComponentClass`, `React.PureComponent`, `React.StatelessComponent`, `React.SFC`
* Must by typed as `React.SFC`, `React.ComponentClass`, `React.PureComponent`, `React.StatelessComponent`, `React.SFC`, `React.ComponentType`
* Must be built with `declarations`, so a `index.d.ts` is available
* In order to accept children elements in Alva, the `children` prop has to be typed explicitly

Expand All @@ -92,13 +92,10 @@ There is no such thing as out-dated and static PNG screens, as the current versi

### Pattern

* **name**: `pattern.json` `.name` or TSDoc `@name` - Name of pattern in pattern list
* **description** `pattern.json` `.description` or TSDoc `@description` - Short description in pattern list

### Pattern Property

* **name**: TSDoc `@name [name]` - Used in the property pane as input label
* **default**: TSDoc `@defaul [value]` - Preset value for this property when creating new elements
* **default**: TSDoc `@default [value]` - Preset value for this property when creating new elements
* **description**: TSDoc `@description [description]` - Used as help text in property pane
* **example**: TSDoc `@example [value]` - Example used as input placeholder if applicable
* **ignore**: TSDoc `@ignore` - Do not show this property
Expand Down
Loading

0 comments on commit 9412309

Please sign in to comment.