├── src ├── components │ ├── nvq-editor │ │ ├── nvq-editor.scss │ │ ├── nvq-editor.tsx │ │ └── readme.md │ ├── nvq-label │ │ ├── readme.md │ │ ├── nvq-label.tsx │ │ └── nvq-label.scss │ ├── nvq-progress-bar │ │ ├── readme.md │ │ ├── nvq-progress-bar.scss │ │ └── nvq-progress-bar.tsx │ └── nvq-autocomplete │ │ ├── readme.md │ │ ├── nvq-autocomplete.scss │ │ └── nvq-autocomplete.tsx ├── examples │ ├── local │ │ ├── nvq-label.html │ │ ├── nvq-editor.html │ │ ├── nvq-progress-bar.html │ │ └── nvq-autocomplete.html │ └── npm │ │ ├── nvq-label.html │ │ ├── nvq-editor.html │ │ ├── nvq-progress-bar.html │ │ └── nvq-autocomplete.html ├── index.html └── components.d.ts ├── .gitignore ├── tsconfig.json ├── .github └── FUNDING.yml ├── stencil.config.ts ├── package.json └── LICENSE /src/components/nvq-editor/nvq-editor.scss: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | www/ 3 | loader/ 4 | 5 | *~ 6 | *.sw[mnpcod] 7 | *.log 8 | *.lock 9 | *.tmp 10 | *.tmp.* 11 | log.txt 12 | *.sublime-project 13 | *.sublime-workspace 14 | 15 | .stencil/ 16 | .idea/ 17 | .vscode/ 18 | .sass-cache/ 19 | .versions/ 20 | node_modules/ 21 | $RECYCLE.BIN/ 22 | 23 | .DS_Store 24 | Thumbs.db 25 | UserInterfaceState.xcuserstate 26 | .env -------------------------------------------------------------------------------- /src/components/nvq-label/readme.md: -------------------------------------------------------------------------------- 1 | # nvq-label 2 | 3 | 4 | 5 | 6 | 7 | 8 | ## Properties 9 | 10 | | Property | Attribute | Description | Type | Default | 11 | | ---------- | ----------- | ----------- | -------- | ----------- | 12 | | `helpText` | `help-text` | | `string` | `undefined` | 13 | | `text` | `text` | | `string` | `undefined` | 14 | 15 | 16 | ---------------------------------------------- 17 | 18 | *Built with [StencilJS](https://stenciljs.com/)* 19 | -------------------------------------------------------------------------------- /src/components/nvq-progress-bar/readme.md: -------------------------------------------------------------------------------- 1 | # nvq-progress-bar 2 | 3 | 4 | 5 | 6 | 7 | 8 | ## Properties 9 | 10 | | Property | Attribute | Description | Type | Default | 11 | | -------- | --------- | ----------- | -------- | ----------- | 12 | | `max` | `max` | | `number` | `100` | 13 | | `value` | `value` | | `number` | `undefined` | 14 | 15 | 16 | ---------------------------------------------- 17 | 18 | *Built with [StencilJS](https://stenciljs.com/)* 19 | -------------------------------------------------------------------------------- /src/components/nvq-progress-bar/nvq-progress-bar.scss: -------------------------------------------------------------------------------- 1 | :host { 2 | .progress-container { 3 | display: flex; 4 | height: var(--progress-height, 20px); 5 | background: var(--progress-background, lightgrey); 6 | overflow: hidden; 7 | border-radius: 20px; 8 | .progress-bar { 9 | background: var(--progress-color, lightblue); 10 | width: calc(var(--current-value, 0) * 100% / var(--max-value, 100)); 11 | } 12 | .progress-bar-remainder { 13 | flex: 1; 14 | } 15 | } 16 | } -------------------------------------------------------------------------------- /src/components/nvq-label/nvq-label.tsx: -------------------------------------------------------------------------------- 1 | import { Component, Prop, h } from '@stencil/core'; 2 | 3 | @Component({ 4 | tag: 'nvq-label', 5 | styleUrl: 'nvq-label.scss', 6 | shadow: true 7 | }) 8 | export class NvqLabel { 9 | 10 | @Prop() text: string; 11 | @Prop() helpText: string; 12 | 13 | render() { 14 | return ( 15 |
16 |
17 | { this.text } 18 | 19 | { this.helpText } 20 | 21 |
22 |
23 | ); 24 | } 25 | } -------------------------------------------------------------------------------- /src/examples/local/nvq-label.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickLabel Demo 8 | 9 | 10 | 11 | 12 | 13 |

nvQuickLabel Demo

14 | 15 | 16 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "allowSyntheticDefaultImports": true, 4 | "allowUnreachableCode": false, 5 | "declaration": false, 6 | "experimentalDecorators": true, 7 | "lib": [ 8 | "dom", 9 | "es2017", 10 | "esnext.asynciterable" 11 | ], 12 | "moduleResolution": "node", 13 | "module": "esnext", 14 | "target": "es2017", 15 | "noUnusedLocals": true, 16 | "noUnusedParameters": true, 17 | "jsx": "react", 18 | "jsxFactory": "h" 19 | }, 20 | "include": [ 21 | "src", 22 | "types/jsx.d.ts" 23 | ], 24 | "exclude": ["node_modules"] 25 | } -------------------------------------------------------------------------------- /src/examples/npm/nvq-label.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickLabel Demo 8 | 9 | 10 | 11 | 12 |

nvQuickLabel Demo

13 | 14 | 15 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [david-poindexter, nvisionative] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /src/components/nvq-progress-bar/nvq-progress-bar.tsx: -------------------------------------------------------------------------------- 1 | import { Component, Prop, Element, h } from '@stencil/core'; 2 | 3 | @Component({ 4 | tag: 'nvq-progress-bar', 5 | styleUrl: 'nvq-progress-bar.scss', 6 | shadow: true 7 | }) 8 | export class NvqProgressBar { 9 | 10 | @Prop() value: number; 11 | @Prop() max: number = 100; 12 | 13 | @Element() el: HTMLElement; 14 | 15 | render() { 16 | this.el.style.setProperty('--current-value', this.value.toString()); 17 | this.el.style.setProperty('--max-value', this.max.toString()); 18 | 19 | return ( 20 |
21 |
22 |
23 |
24 | ); 25 | } 26 | } -------------------------------------------------------------------------------- /stencil.config.ts: -------------------------------------------------------------------------------- 1 | import { Config } from '@stencil/core'; 2 | import { sass } from '@stencil/sass'; 3 | 4 | export const config: Config = { 5 | namespace: 'nvq-components', 6 | outputTargets: [ 7 | { 8 | type: 'dist', 9 | esmLoaderPath: '../loader' 10 | }, 11 | { 12 | type: 'docs-readme' 13 | }, 14 | { 15 | type: 'www', 16 | copy: [ 17 | { src: 'examples' } 18 | ], 19 | serviceWorker: null // disable service workers 20 | } 21 | ], 22 | bundles: [ 23 | { components: ['nvq-progress-bar'] }, 24 | { components: ['nvq-editor'] }, 25 | { components: ['nvq-label'] } , 26 | { components: ['nvq-autocomplete'] } 27 | ], 28 | plugins: [ 29 | sass() 30 | ] 31 | }; -------------------------------------------------------------------------------- /src/components/nvq-autocomplete/readme.md: -------------------------------------------------------------------------------- 1 | # nvq-autocomplete 2 | 3 | 4 | 5 | 6 | 7 | 8 | ## Properties 9 | 10 | | Property | Attribute | Description | Type | Default | 11 | | ------------- | -------------- | ----------- | --------- | ----------- | 12 | | `itemsSource` | `items-source` | | `string` | `undefined` | 13 | | `name` | `name` | | `string` | `undefined` | 14 | | `placeholder` | `placeholder` | | `string` | `undefined` | 15 | | `remote` | `remote` | | `boolean` | `false` | 16 | | `value` | `value` | | `string` | `undefined` | 17 | | `width` | `width` | | `string` | `undefined` | 18 | 19 | 20 | ---------------------------------------------- 21 | 22 | *Built with [StencilJS](https://stenciljs.com/)* 23 | -------------------------------------------------------------------------------- /src/examples/local/nvq-editor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickEditor Demo 8 | 9 | 10 | 11 | 12 | 13 |

nvQuickEditor Demo

14 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /src/examples/local/nvq-progress-bar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickProgressBar Demo 8 | 9 | 10 | 11 | 12 | 13 |

nvQuickProgressBar Demo

14 | 15 |
 
16 | 17 | 22 | 23 | -------------------------------------------------------------------------------- /src/examples/npm/nvq-editor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickEditor Demo 8 | 9 | 10 | 11 | 12 |

nvQuickEditor Demo

13 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /src/examples/npm/nvq-progress-bar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickProgressBar Demo 8 | 9 | 10 | 11 | 12 |

nvQuickProgressBar Demo

13 | 14 |
 
15 | 16 | 21 | 22 | -------------------------------------------------------------------------------- /src/components/nvq-autocomplete/nvq-autocomplete.scss: -------------------------------------------------------------------------------- 1 | nvq-autocomplete { 2 | .autocomplete { 3 | position: relative; 4 | display: inline-block; 5 | 6 | input { 7 | border: 1px solid transparent; 8 | background-color: #f1f1f1; 9 | font-size: 16px; 10 | padding: 10px; 11 | width:100%; 12 | -webkit-box-sizing: border-box; 13 | -moz-box-sizing: border-box; 14 | box-sizing: border-box; 15 | } 16 | 17 | .autocomplete-items { 18 | position: absolute; 19 | z-index: 100; 20 | top:100%; 21 | left:0; 22 | right:0; 23 | background-color: #fff; 24 | 25 | .autocomplete-row { 26 | padding: 1em; 27 | border-left: solid 1px #d4d4d4; 28 | border-right: solid 1px #d4d4d4; 29 | border-bottom: solid 1px #d4d4d4; 30 | 31 | &:first-child { 32 | border-top: solid 1px #d4d4d4; 33 | } 34 | } 35 | 36 | .autocomplete-row:hover { 37 | background-color: #e9e9e9; 38 | cursor: pointer; 39 | } 40 | } 41 | } 42 | } -------------------------------------------------------------------------------- /src/components/nvq-label/nvq-label.scss: -------------------------------------------------------------------------------- 1 | :host { 2 | /* Tooltip container */ 3 | .tooltip { 4 | position: relative; 5 | display: inline-block; 6 | border-bottom: 1px dashed #5b5b5b; /* If you want dots under the hoverable text */ 7 | } 8 | 9 | /* Tooltip text */ 10 | .tooltip .tooltiptext { 11 | visibility: hidden; 12 | width: 120px; 13 | background-color: #5b5b5b; 14 | color: #fff; 15 | text-align: center; 16 | padding: 5px 0; 17 | border-radius: 6px; 18 | 19 | /* Position the tooltip text - see examples below! */ 20 | position: absolute; 21 | z-index: 1; 22 | } 23 | 24 | /* Show the tooltip text when you mouse over the tooltip container */ 25 | .tooltip:hover .tooltiptext { 26 | visibility: visible; 27 | } 28 | 29 | .tooltip .tooltiptext { 30 | top: -5px; 31 | left: 110%; 32 | } 33 | 34 | .tooltip .tooltiptext::after { 35 | content: " "; 36 | position: absolute; 37 | top: 50%; 38 | right: 100%; /* To the left of the tooltip */ 39 | margin-top: -5px; 40 | border-width: 5px; 41 | border-style: solid; 42 | border-color: transparent #5b5b5b transparent transparent; 43 | } 44 | } -------------------------------------------------------------------------------- /src/examples/local/nvq-autocomplete.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickAutoComplete Demo 8 | 9 | 10 | 11 | 12 |

nvqAutoComplete Demo

13 |

Local items source

14 | 15 |

Remote items source

16 |

The remote items-source makes a few assumptions:

17 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@nvisionative/nvq-components", 3 | "version": "0.0.4", 4 | "description": "Collection of web components", 5 | "keywords": [], 6 | "author": "nvisionative", 7 | "license": "GPL-3.0", 8 | "main": "dist/index.js", 9 | "module": "dist/index.mjs", 10 | "es2015": "dist/esm/index.mjs", 11 | "es2017": "dist/esm/index.mjs", 12 | "types": "dist/types/components.d.ts", 13 | "collection": "dist/collection/collection-manifest.json", 14 | "collection:main": "dist/collection/index.js", 15 | "unpkg": "dist/nvq-components/nvq-components.js", 16 | "files": [ 17 | "dist/", 18 | "loader/" 19 | ], 20 | "scripts": { 21 | "build": "stencil build --docs", 22 | "start": "stencil build --dev --watch --serve", 23 | "test": "stencil test --spec --e2e", 24 | "test.watch": "stencil test --spec --e2e --watchAll", 25 | "generate": "stencil generate" 26 | }, 27 | "dependencies": { 28 | "@types/quill": "^2.0.9", 29 | "request": "^2.88.2", 30 | "request-promise-native": "^1.0.9" 31 | }, 32 | "devDependencies": { 33 | "@stencil/core": "^2.9.0", 34 | "@stencil/sass": "^1.5.2", 35 | "@stencil/utils": "0.0.5", 36 | "@types/jest": "^27.0.2", 37 | "@types/puppeteer": "^5.4.4", 38 | "jest": "^27.2.5", 39 | "jest-cli": "^27.2.5", 40 | "puppeteer": "^10.4.0", 41 | "quill": "^1.3.7" 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/examples/npm/nvq-autocomplete.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | nvQuickAutoComplete Demo 8 | 9 | 10 | 11 | 12 |

nvqAutoComplete Demo

13 |

Local items source

14 | 15 |

Remote items source

16 |

The remote items-source makes a few assumptions:

17 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /src/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Demos 8 | 9 | 10 | 11 |

Demos

12 |

Local

13 | 16 | 19 | 22 | 25 |

npm

26 | 29 | 32 | 35 | 38 | 39 | -------------------------------------------------------------------------------- /src/components/nvq-autocomplete/nvq-autocomplete.tsx: -------------------------------------------------------------------------------- 1 | import { Component, Prop, Element, Watch, h } from '@stencil/core'; 2 | 3 | @Component({ 4 | tag: 'nvq-autocomplete', 5 | styleUrl: 'nvq-autocomplete.scss', 6 | shadow: false 7 | }) 8 | export class NvqAutocomplete { 9 | 10 | @Prop() name: string; 11 | @Prop() placeholder: string; 12 | @Prop() value: string; 13 | @Prop() itemsSource: string; 14 | @Prop() width: string; 15 | @Prop() remote:boolean = false; 16 | 17 | @Element() el: HTMLElement; 18 | 19 | items:string[] = []; 20 | endpoint:string = ""; 21 | style:{ [key:string]:string } = {}; 22 | 23 | @Watch('itemsSource') 24 | itemsSourceHandler(newValue:string) { 25 | if (this.remote) { 26 | this.endpoint = newValue; 27 | } else { 28 | this.items = newValue.split(","); 29 | } 30 | } 31 | 32 | isLocal() { 33 | return this.endpoint == "" || this.endpoint == null || this.endpoint == undefined; 34 | } 35 | 36 | async handleInput(e) { 37 | let target = e.target; 38 | if (this.items === [] || this.items.length == 0) { 39 | this.itemsSourceHandler(this.itemsSource); 40 | } 41 | 42 | let buildAutoCompleteItem = (name:string) => { 43 | let item:HTMLElement = document.createElement("div"); 44 | item.setAttribute("class", "autocomplete-row"); 45 | item.innerHTML = "" + name + ""; 46 | 47 | item.addEventListener('click', () => { 48 | target.value = name; 49 | clear(); 50 | }); 51 | 52 | return item; 53 | } 54 | 55 | let createAutoCompleteContainer = (items:HTMLElement[]) => { 56 | let autocomplete:HTMLElement = document.createElement("div"); 57 | autocomplete.setAttribute("id", "autocomplete-list"); 58 | autocomplete.setAttribute("class", "autocomplete-items"); 59 | 60 | for (let autocompleteItem of items) { 61 | autocomplete.appendChild(autocompleteItem); 62 | } 63 | 64 | return autocomplete; 65 | } 66 | 67 | let getLocalResults = () => { 68 | let data:HTMLElement[] = []; 69 | for (let index in this.items) { 70 | if (this.items[index].toLowerCase().includes(input.toLocaleLowerCase())) { 71 | let autocompleteItem:HTMLElement = buildAutoCompleteItem(this.items[index]); 72 | data.push(autocompleteItem); 73 | } 74 | } 75 | 76 | return data; 77 | } 78 | 79 | let getRequest = (query:string) => { 80 | let uri:string = this.endpoint + query; 81 | var promise = fetch(uri) 82 | .then((response) => response.json()); 83 | 84 | return promise; 85 | } 86 | 87 | let getRemoteResults = (input:string, callback: (newData:string[]) => any) => { 88 | getRequest(input).then((response) => { 89 | if (response) { 90 | callback(response); 91 | } else { 92 | clear(); 93 | } 94 | }); 95 | } 96 | 97 | let clear = () => { 98 | var container = target.parentNode.querySelector("#autocomplete-list"); 99 | if (container != null && container != undefined) { 100 | target.parentNode.removeChild(container); 101 | } 102 | } 103 | 104 | let hydrateAutocomplete = (results:HTMLElement[]) => { 105 | clear(); 106 | if (results.length > 0) { 107 | let autocomplete:HTMLElement = createAutoCompleteContainer(results); 108 | target.parentNode.appendChild(autocomplete); 109 | } 110 | } 111 | 112 | 113 | let input:string = target.value; 114 | if (input === "" || input === undefined) { 115 | clear(); 116 | return; 117 | } 118 | 119 | if (this.isLocal()) { 120 | let results:HTMLElement[] = getLocalResults(); 121 | hydrateAutocomplete(results); 122 | } else { 123 | getRemoteResults(input, (remoteItemsSource) => { 124 | let results:HTMLElement[] = []; 125 | for (let index in remoteItemsSource) { 126 | let currentElement:HTMLElement = buildAutoCompleteItem(remoteItemsSource[index]); 127 | results.push(currentElement); 128 | } 129 | 130 | hydrateAutocomplete(results); 131 | }); 132 | } 133 | } 134 | 135 | updateStyles() { 136 | this.style["width"] = this.width; 137 | } 138 | 139 | render() { 140 | this.updateStyles(); 141 | 142 | return ( 143 |
144 |
145 | await this.handleInput(e)} type="search" name={this.name} placeholder={this.placeholder} value={this.value} /> 146 |
147 |
148 | ); 149 | } 150 | } -------------------------------------------------------------------------------- /src/components.d.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable */ 2 | /* tslint:disable */ 3 | /** 4 | * This is an autogenerated file created by the Stencil compiler. 5 | * It contains typing information for all components that exist in this project. 6 | */ 7 | import { HTMLStencilElement, JSXBase } from "@stencil/core/internal"; 8 | import { CustomOption } from "./components/nvq-editor/nvq-editor"; 9 | export namespace Components { 10 | interface NvqAutocomplete { 11 | "itemsSource": string; 12 | "name": string; 13 | "placeholder": string; 14 | "remote": boolean; 15 | "value": string; 16 | "width": string; 17 | } 18 | interface NvqEditor { 19 | "bounds": HTMLElement | string; 20 | "content": string; 21 | "customOptions": CustomOption[]; 22 | "customToolbarPosition": 'top' | 'bottom'; 23 | "debug": string; 24 | "format": 'html' | 'text' | 'json'; 25 | "formats": string[]; 26 | "maxLength": number; 27 | "minLength": number; 28 | "modules": { [index: string]: Object }; 29 | "placeholder": string; 30 | "preserveWhitespace": boolean; 31 | "readOnly": boolean; 32 | "required": boolean; 33 | "scrollingContainer": HTMLElement | string; 34 | "strict": boolean; 35 | "styles": string; 36 | "theme": string; 37 | } 38 | interface NvqLabel { 39 | "helpText": string; 40 | "text": string; 41 | } 42 | interface NvqProgressBar { 43 | "max": number; 44 | "value": number; 45 | } 46 | } 47 | declare global { 48 | interface HTMLNvqAutocompleteElement extends Components.NvqAutocomplete, HTMLStencilElement { 49 | } 50 | var HTMLNvqAutocompleteElement: { 51 | prototype: HTMLNvqAutocompleteElement; 52 | new (): HTMLNvqAutocompleteElement; 53 | }; 54 | interface HTMLNvqEditorElement extends Components.NvqEditor, HTMLStencilElement { 55 | } 56 | var HTMLNvqEditorElement: { 57 | prototype: HTMLNvqEditorElement; 58 | new (): HTMLNvqEditorElement; 59 | }; 60 | interface HTMLNvqLabelElement extends Components.NvqLabel, HTMLStencilElement { 61 | } 62 | var HTMLNvqLabelElement: { 63 | prototype: HTMLNvqLabelElement; 64 | new (): HTMLNvqLabelElement; 65 | }; 66 | interface HTMLNvqProgressBarElement extends Components.NvqProgressBar, HTMLStencilElement { 67 | } 68 | var HTMLNvqProgressBarElement: { 69 | prototype: HTMLNvqProgressBarElement; 70 | new (): HTMLNvqProgressBarElement; 71 | }; 72 | interface HTMLElementTagNameMap { 73 | "nvq-autocomplete": HTMLNvqAutocompleteElement; 74 | "nvq-editor": HTMLNvqEditorElement; 75 | "nvq-label": HTMLNvqLabelElement; 76 | "nvq-progress-bar": HTMLNvqProgressBarElement; 77 | } 78 | } 79 | declare namespace LocalJSX { 80 | interface NvqAutocomplete { 81 | "itemsSource"?: string; 82 | "name"?: string; 83 | "placeholder"?: string; 84 | "remote"?: boolean; 85 | "value"?: string; 86 | "width"?: string; 87 | } 88 | interface NvqEditor { 89 | "bounds"?: HTMLElement | string; 90 | "content"?: string; 91 | "customOptions"?: CustomOption[]; 92 | "customToolbarPosition"?: 'top' | 'bottom'; 93 | "debug"?: string; 94 | "format"?: 'html' | 'text' | 'json'; 95 | "formats"?: string[]; 96 | "maxLength"?: number; 97 | "minLength"?: number; 98 | "modules"?: { [index: string]: Object }; 99 | "onContentChanged"?: (event: CustomEvent) => void; 100 | "onEditorBlur"?: (event: CustomEvent<{ 101 | editor: any; 102 | source: string; 103 | }>) => void; 104 | "onEditorChange"?: (event: CustomEvent<| { 105 | editor: any; 106 | event: 'text-change'; 107 | content: any; 108 | text: string; 109 | html: string; 110 | delta: any; 111 | oldDelta: any; 112 | source: string; 113 | } 114 | | { 115 | editor: any; 116 | event: 'selection-change'; 117 | range: any; 118 | oldRange: any; 119 | source: string; 120 | }>) => void; 121 | "onEditorContentChange"?: (event: CustomEvent<{ 122 | editor: any; 123 | content: any; 124 | text: string; 125 | html: string; 126 | delta: any; 127 | oldDelta: any; 128 | source: string; 129 | }>) => void; 130 | "onEditorCreated"?: (event: CustomEvent) => void; 131 | "onEditorFocus"?: (event: CustomEvent<{ 132 | editor: any; 133 | source: string; 134 | }>) => void; 135 | "onEditorInit"?: (event: CustomEvent) => void; 136 | "onEditorSelectionChange"?: (event: CustomEvent<{ 137 | editor: any; 138 | range: any; 139 | oldRange: any; 140 | source: string; 141 | }>) => void; 142 | "onSelectionChanged"?: (event: CustomEvent) => void; 143 | "placeholder"?: string; 144 | "preserveWhitespace"?: boolean; 145 | "readOnly"?: boolean; 146 | "required"?: boolean; 147 | "scrollingContainer"?: HTMLElement | string; 148 | "strict"?: boolean; 149 | "styles"?: string; 150 | "theme"?: string; 151 | } 152 | interface NvqLabel { 153 | "helpText"?: string; 154 | "text"?: string; 155 | } 156 | interface NvqProgressBar { 157 | "max"?: number; 158 | "value"?: number; 159 | } 160 | interface IntrinsicElements { 161 | "nvq-autocomplete": NvqAutocomplete; 162 | "nvq-editor": NvqEditor; 163 | "nvq-label": NvqLabel; 164 | "nvq-progress-bar": NvqProgressBar; 165 | } 166 | } 167 | export { LocalJSX as JSX }; 168 | declare module "@stencil/core" { 169 | export namespace JSX { 170 | interface IntrinsicElements { 171 | "nvq-autocomplete": LocalJSX.NvqAutocomplete & JSXBase.HTMLAttributes; 172 | "nvq-editor": LocalJSX.NvqEditor & JSXBase.HTMLAttributes; 173 | "nvq-label": LocalJSX.NvqLabel & JSXBase.HTMLAttributes; 174 | "nvq-progress-bar": LocalJSX.NvqProgressBar & JSXBase.HTMLAttributes; 175 | } 176 | } 177 | } 178 | -------------------------------------------------------------------------------- /src/components/nvq-editor/nvq-editor.tsx: -------------------------------------------------------------------------------- 1 | import { Component, ComponentDidLoad, Element, Event, EventEmitter, h, Prop, Watch, Host } from '@stencil/core'; 2 | import Quill from 'quill'; 3 | //import * as QuillNamespace from 'quill'; 4 | 5 | export interface CustomOption { 6 | import: string; 7 | whitelist: Array; 8 | } 9 | 10 | @Component({ 11 | tag: 'nvq-editor', 12 | styleUrl: 'nvq-editor.scss', 13 | shadow: false 14 | }) 15 | export class NvqEditor implements ComponentDidLoad { 16 | 17 | emptyArray: any[] = []; 18 | 19 | @Prop() bounds: HTMLElement | string; 20 | @Prop() content: string; 21 | @Prop() customOptions: CustomOption[] = []; 22 | @Prop() customToolbarPosition: 'top' | 'bottom' = 'top'; 23 | @Prop() debug: string = 'warn'; 24 | @Prop() format: 'html' | 'text' | 'json' = 'html'; 25 | @Prop() formats: string[]; 26 | @Prop() modules: { [index: string]: Object } = { 27 | toolbar: [ 28 | ['bold', 'italic', 'underline', 'strike'], 29 | ['blockquote', 'code-block'], 30 | 31 | [{ header: 1 }, { header: 2 }], // custom button values 32 | [{ list: 'ordered' }, { list: 'bullet' }], 33 | [{ script: 'sub' }, { script: 'super' }], // superscript/subscript 34 | [{ indent: '-1' }, { indent: '+1' }], // outdent/indent 35 | [{ direction: 'rtl' }], // text direction 36 | [{ size: ['small', false, 'large', 'huge'] }], // custom dropdown 37 | [{ header: [1, 2, 3, 4, 5, 6, false] }], 38 | 39 | [ 40 | { color: this.emptyArray.slice() }, 41 | { background: this.emptyArray.slice() } 42 | ], // dropdown with defaults from theme 43 | [{ font: this.emptyArray.slice() }], 44 | [{ align: this.emptyArray.slice() }], 45 | 46 | ['clean'], // remove formatting button 47 | ['link', 'image', 'video'] // link and image, video 48 | ] 49 | }; 50 | @Prop() placeholder: string = 'Enter some really cool content...'; 51 | @Prop() readOnly: boolean; 52 | @Prop() scrollingContainer: HTMLElement | string; 53 | @Prop() strict: boolean = true; 54 | @Prop() maxLength: number; 55 | @Prop() minLength: number; 56 | @Prop() preserveWhitespace: boolean = false; 57 | @Prop() required: boolean; 58 | @Prop() styles: string = '{}'; 59 | @Prop({ mutable: true }) theme: string = 'snow'; // default theme to "snow", but make sure the theme can be changed in case user enters invalid theme name 60 | 61 | @Event() editorCreated: EventEmitter; 62 | @Event() contentChanged: EventEmitter; 63 | @Event() selectionChanged: EventEmitter; 64 | 65 | @Event() editorInit: EventEmitter; 66 | @Event() editorChange: EventEmitter< 67 | | { 68 | editor: any; 69 | event: 'text-change'; 70 | content: any; 71 | text: string; 72 | html: string; 73 | delta: any; 74 | oldDelta: any; 75 | source: string; 76 | } 77 | | { 78 | editor: any; 79 | event: 'selection-change'; 80 | range: any; 81 | oldRange: any; 82 | source: string; 83 | } 84 | >; 85 | @Event() editorContentChange: EventEmitter<{ 86 | editor: any; 87 | content: any; 88 | text: string; 89 | html: string; 90 | delta: any; 91 | oldDelta: any; 92 | source: string; 93 | }>; 94 | @Event() editorSelectionChange: EventEmitter<{ 95 | editor: any; 96 | range: any; 97 | oldRange: any; 98 | source: string; 99 | }>; 100 | @Event() editorFocus: EventEmitter<{ 101 | editor: any; 102 | source: string; 103 | }>; 104 | @Event() editorBlur: EventEmitter<{ 105 | editor: any; 106 | source: string; 107 | }>; 108 | 109 | /*@State() available : boolean = false;*/ 110 | 111 | /*@Method() 112 | myMethod() { 113 | //do something 114 | }*/ 115 | 116 | render() { 117 | 118 | return ( 119 |
120 | ); 121 | } 122 | 123 | componentWillLoad() { 124 | // do something 125 | } 126 | 127 | componentDidLoad() { 128 | this.init().then(() => { 129 | //console.log("nvQuickEditor did load.") 130 | }, (err) => { 131 | console.log(err); 132 | }); 133 | 134 | let quill : any = Quill; //this one is important, otherwise 'Quill' is undefined 135 | //let Quill: any = QuillNamespace; 136 | 137 | let options = { 138 | bounds: this.bounds ? (this.bounds === 'self' ? '#nvq-editor' : this.bounds) : document.body, 139 | debug: this.debug, 140 | formats: this.formats, 141 | maxLength: this.maxLength, 142 | minLength: this.minLength, 143 | modules: this.modules, 144 | placeholder: this.placeholder, 145 | readOnly: this.readOnly || false, 146 | required: this.required, 147 | scrollingContainer: this.scrollingContainer, 148 | strict: this.strict, 149 | theme: this.theme || 'snow', 150 | }; 151 | console.log(options); 152 | new quill('#nvq-editor', options); 153 | } 154 | 155 | init(): Promise { 156 | 157 | return new Promise((resolve, reject) => { 158 | 159 | this.initEditor().then(() => { 160 | resolve(true); 161 | }, (err) => { 162 | reject(err); 163 | }); 164 | 165 | }); 166 | 167 | } 168 | 169 | initEditor(): Promise { 170 | 171 | return new Promise((resolve) => { 172 | 173 | // load Quill theme based on theme @Prop 174 | if(this.theme === 'bubble') { 175 | let loadQuillCss = document.createElement('link'); 176 | loadQuillCss.href = 'https://cdn.quilljs.com/1.3.7/quill.bubble.css'; 177 | loadQuillCss.rel = "stylesheet"; 178 | document.body.appendChild(loadQuillCss); 179 | } else { 180 | this.theme = 'snow'; 181 | let loadQuillCss = document.createElement('link'); 182 | loadQuillCss.href = 'https://cdn.quilljs.com/1.3.7/quill.snow.css'; 183 | loadQuillCss.rel = "stylesheet"; 184 | document.body.appendChild(loadQuillCss); 185 | } 186 | 187 | resolve(true); 188 | }); 189 | } 190 | 191 | 192 | } -------------------------------------------------------------------------------- /src/components/nvq-editor/readme.md: -------------------------------------------------------------------------------- 1 | # nvq-editor 2 | 3 | 4 | 5 | 6 | 7 | 8 | ## Properties 9 | 10 | | Property | Attribute | Description | Type | Default | 11 | | -------------------- | --------------------- | ----------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 12 | | `bounds` | `bounds` | | `HTMLElement \| string` | `undefined` | 13 | | `customOptions` | -- | | `CustomOption[]` | `[]` | 14 | | `format` | `format` | | `"html" \| "object" \| "text"` | `'html'` | 15 | | `formats` | -- | | `string[]` | `undefined` | 16 | | `maxLength` | `max-length` | | `number` | `undefined` | 17 | | `minLength` | `min-length` | | `number` | `undefined` | 18 | | `modules` | -- | | `{ [index: string]: Object; }` | `{ toolbar: [ ['bold', 'italic', 'underline', 'strike'], ['blockquote', 'code-block'], [{ header: 1 }, { header: 2 }], // custom button values [{ list: 'ordered' }, { list: 'bullet' }], [{ script: 'sub' }, { script: 'super' }], // superscript/subscript [{ indent: '-1' }, { indent: '+1' }], // outdent/indent [{ direction: 'rtl' }], // text direction [{ size: ['small', false, 'large', 'huge'] }], // custom dropdown [{ header: [1, 2, 3, 4, 5, 6, false] }], [ { color: this.emptyArray.slice() }, { background: this.emptyArray.slice() } ], // dropdown with defaults from theme [{ font: this.emptyArray.slice() }], [{ align: this.emptyArray.slice() }], ['clean'], // remove formatting button ['link', 'image', 'video'] // link and image, video ] }` | 19 | | `placeholder` | `placeholder` | | `string` | `undefined` | 20 | | `readOnly` | `read-only` | | `boolean` | `undefined` | 21 | | `required` | `required` | | `boolean` | `undefined` | 22 | | `scrollingContainer` | `scrolling-container` | | `HTMLElement \| string` | `undefined` | 23 | | `strict` | `strict` | | `boolean` | `true` | 24 | | `theme` | `theme` | | `string` | `'snow'` | 25 | 26 | 27 | ## Events 28 | 29 | | Event | Description | Type | 30 | | -------------------- | ----------- | ------------------ | 31 | | `onContentChanged` | | `CustomEvent` | 32 | | `onEditorCreated` | | `CustomEvent` | 33 | | `onSelectionChanged` | | `CustomEvent` | 34 | 35 | 36 | ---------------------------------------------- 37 | 38 | *Built with [StencilJS](https://stenciljs.com/)* 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------