Skip to content

Commit

Permalink
docs: gen component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KillerCodeMonkey committed Mar 24, 2020
1 parent 9581daa commit 32cdfe8
Show file tree
Hide file tree
Showing 10 changed files with 91 additions and 3 deletions.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"dist/"
],
"scripts": {
"build": "stencil build",
"build": "stencil build --docs",
"build:deploy": "stencil build && cp ./src/index.html ./dist && gh-pages -d ./dist",
"prepublishOnly": "npm run build",
"start": "stencil build --dev --watch --serve",
Expand All @@ -35,8 +35,8 @@
"quill": "^1.3.6"
},
"devDependencies": {
"@stencil/core": "^1.4.0",
"@types/jest": "^25.1.0",
"@stencil/core": "^1.11.2",
"@types/jest": "^25.1.4",
"@types/quill": "^1.3.10",
"gh-pages": "2.2.0",
"jest": "^25.1.0",
Expand Down
3 changes: 3 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ XRP Wallet Address:
```

### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-editor)
- content - the base content of the editor passed as string or JSON string
- readOnly (true | false) if user can edit content
- formats - array of allowed formats/groupings
Expand Down Expand Up @@ -191,6 +192,7 @@ It renders a readOnly quilljs editor without a border and toolbar. Does not prov
```

### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-view)
- content - the base content of the editor passed as string or JSON string
- formats - array of allowed formats/groupings
- format - model format - default: `html`, values: `html | text | json`, sets the model value type - html = html string, json = quill operations as json string, text = plain text
Expand All @@ -212,6 +214,7 @@ It renders an quilljs html string as you would expect it without createing a qui
```

### Config
- [Check the component readme](https://github.com/KillerCodeMonkey/stencil-quill/tree/master/src/components/quill-view-html)
- content - the base content of the editor passed as string or JSON string
- theme - bubble/snow, default is `snow`

Expand Down
File renamed without changes.
42 changes: 42 additions & 0 deletions src/components/quill-editor/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# quill-editor



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| ----------------------- | ------------------------- | ----------- | ---------------------------- | ------------------------ |
| `bounds` | `bounds` | | `HTMLElement \| string` | `undefined` |
| `content` | `content` | | `string` | `undefined` |
| `customToolbarPosition` | `custom-toolbar-position` | | `"bottom" \| "top"` | `'top'` |
| `debug` | `debug` | | `string` | `'warn'` |
| `format` | `format` | | `"html" \| "json" \| "text"` | `'html'` |
| `formats` | -- | | `string[]` | `undefined` |
| `modules` | `modules` | | `string` | `undefined` |
| `placeholder` | `placeholder` | | `string` | `'Insert text here ...'` |
| `preserveWhitespace` | `preserve-whitespace` | | `boolean` | `false` |
| `readOnly` | `read-only` | | `boolean` | `undefined` |
| `scrollingContainer` | `scrolling-container` | | `HTMLElement \| string` | `undefined` |
| `strict` | `strict` | | `boolean` | `true` |
| `styles` | `styles` | | `string` | `'{}'` |
| `theme` | `theme` | | `string` | `undefined` |


## Events

| Event | Description | Type |
| ----------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `editorBlur` | | `CustomEvent<{ editor: any; source: string; }>` |
| `editorChange` | | `CustomEvent<{ editor: any; event: "selection-change"; range: any; oldRange: any; source: string; } \| { editor: any; event: "text-change"; content: any; text: string; html: string; delta: any; oldDelta: any; source: string; }>` |
| `editorContentChange` | | `CustomEvent<{ editor: any; content: any; text: string; html: string; delta: any; oldDelta: any; source: string; }>` |
| `editorFocus` | | `CustomEvent<{ editor: any; source: string; }>` |
| `editorInit` | | `CustomEvent<any>` |
| `editorSelectionChange` | | `CustomEvent<{ editor: any; range: any; oldRange: any; source: string; }>` |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions src/components/quill-view-html/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# quill-view-html



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| --------- | --------- | ----------- | -------- | ----------- |
| `content` | `content` | | `string` | `undefined` |
| `theme` | `theme` | | `string` | `'snow'` |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
File renamed without changes.
File renamed without changes.
25 changes: 25 additions & 0 deletions src/components/quill-view/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# quill-view



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| -------------------- | --------------------- | ----------- | ---------------------------- | ----------- |
| `content` | `content` | | `string` | `undefined` |
| `debug` | `debug` | | `string` | `'warn'` |
| `format` | `format` | | `"html" \| "json" \| "text"` | `'html'` |
| `formats` | -- | | `string[]` | `undefined` |
| `modules` | `modules` | | `string` | `undefined` |
| `preserveWhitespace` | `preserve-whitespace` | | `boolean` | `false` |
| `strict` | `strict` | | `boolean` | `true` |
| `styles` | `styles` | | `string` | `'{}'` |
| `theme` | `theme` | | `string` | `undefined` |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*

0 comments on commit 32cdfe8

Please sign in to comment.