Skip to content

Commit

Permalink
readme: remove outdated quill options
Browse files Browse the repository at this point in the history
  • Loading branch information
KillerCodeMonkey committed Feb 7, 2024
1 parent cbd089d commit d9cfa35
Show file tree
Hide file tree
Showing 6 changed files with 1 addition and 16 deletions.
2 changes: 0 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ PayPal: [PayPal.Me/bengtler](https://paypal.me/bengtler)
- styles - set a styles object, e.g. `styles="{height: '250px'}"`
- placeholder - placeholder text, default is `Insert text here ...`
- bounds - boundary of the editor, default `document.body`, pass 'self' to attach the editor element
- strict - default: true, sets editor in strict mode
- scrollingContainer - default '.ql-editor', allows to set scrolling container
- possbility to create a custom toolbar via a custom slot `quill-toolbar`:

```
Expand Down
4 changes: 0 additions & 4 deletions src/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ export namespace Components {
"placeholder": string;
"preserveWhitespace": boolean;
"readOnly": boolean;
"scrollingContainer": HTMLElement | string;
"strict": boolean;
"styles": string;
"theme": string;
}
Expand Down Expand Up @@ -171,8 +169,6 @@ declare namespace LocalJSX {
"placeholder"?: string;
"preserveWhitespace"?: boolean;
"readOnly"?: boolean;
"scrollingContainer"?: HTMLElement | string;
"strict"?: boolean;
"styles"?: string;
"theme"?: string;
}
Expand Down
2 changes: 0 additions & 2 deletions src/components/quill-editor/quill-editor.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,12 @@ describe('QuillEditorComponent', () => {
expect(component.format).toEqual('html');
expect(component.debug).toEqual('warn');
expect(component.styles).toEqual('{"height": "200px"}');
expect(component.strict).toBe(true);
expect(component.preserveWhitespace).toBe(false);
expect(component.modules).toEqual('{"toolbar":true}');

expect(component.quillEditor.options.modules).toEqual({ toolbar: true });
expect(component.quillEditor.options.theme).toEqual('snow');
expect(component.quillEditor.options.debug).toEqual('warn');
expect(component.quillEditor.options.strict).toBe(true);
});

it('renders styles changes', async () => {
Expand Down
6 changes: 1 addition & 5 deletions src/components/quill-editor/quill-editor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ export class QuillEditorComponent implements ComponentDidLoad {
@Prop() modules?: string;
@Prop() placeholder: string = 'Insert text here ...';
@Prop() readOnly: boolean;
@Prop() scrollingContainer: HTMLElement | string;
@Prop() strict: boolean = true;
@Prop() styles: string = '{}';
@Prop() theme: string = 'snow';
@Prop() customToolbarPosition: 'top' | 'bottom' = 'top';
Expand Down Expand Up @@ -165,9 +163,7 @@ export class QuillEditorComponent implements ComponentDidLoad {
readOnly: this.readOnly || false,
theme: this.theme || 'snow',
formats: this.formats,
bounds: this.bounds ? (this.bounds === 'self' ? this.editorElement : this.bounds) : document.body,
strict: this.strict,
scrollingContainer: this.scrollingContainer,
bounds: this.bounds ? (this.bounds === 'self' ? this.editorElement : this.bounds) : document.body
});

if (this.styles) {
Expand Down
2 changes: 0 additions & 2 deletions src/components/quill-editor/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
| `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` | `'snow'` |

Expand Down
1 change: 0 additions & 1 deletion src/components/quill-view/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
| `formats` | -- | | `string[]` | `undefined` |
| `modules` | `modules` | | `string` | `undefined` |
| `preserveWhitespace` | `preserve-whitespace` | | `boolean` | `false` |
| `strict` | `strict` | | `boolean` | `true` |
| `styles` | `styles` | | `string` | `'{}'` |
| `theme` | `theme` | | `string` | `'snow'` |

Expand Down

0 comments on commit d9cfa35

Please sign in to comment.