diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..51d1042
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+ "eslint.experimental.useFlatConfig": true,
+ "eslint.options": { "overrideConfigFile": "./config/eslint.config.mjs" },
+}
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..75b5248
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/config/eslint.config.mjs b/config/eslint.config.mjs
index 612f561..c521439 100644
--- a/config/eslint.config.mjs
+++ b/config/eslint.config.mjs
@@ -1,14 +1,14 @@
import { FlatCompat } from '@eslint/eslintrc';
import globals from 'globals';
-import path from 'path';
+import {dirname } from 'path';
import { fileURLToPath } from 'url';
import js from '@eslint/js';
// mimic CommonJS variables -- not needed if using CommonJS
-const filename = fileURLToPath(import.meta.url);
-const dirname = path.dirname(filename);
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = dirname(_filename);
const compat = new FlatCompat({
- baseDirectory: dirname,
+ baseDirectory: _dirname,
});
export default [
@@ -16,7 +16,14 @@ export default [
{
languageOptions: {
globals: globals.browser,
+ ecmaVersion: 'latest',
+ sourceType: 'module',
},
},
...compat.extends('airbnb-base'),
-];
\ No newline at end of file
+ {
+ rules: {
+ 'import/prefer-default-export': 'off',
+ },
+ }
+];
diff --git a/package-lock.json b/package-lock.json
index 4b67ef7..4e87c6d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -10,6 +10,7 @@
"license": "Apache",
"dependencies": {
"bootstrap-icons": "^1.11.3",
+ "highlight.js": "^11.9.0",
"lit": "^3.1.2"
},
"devDependencies": {
@@ -1930,6 +1931,14 @@
"node": ">= 0.4"
}
},
+ "node_modules/highlight.js": {
+ "version": "11.9.0",
+ "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-11.9.0.tgz",
+ "integrity": "sha512-fJ7cW7fQGCYAkgv4CPfwFHrfd/cLS4Hau96JuJ+ZTOWhjnhoeN1ub1tFmALm/+lW5z4WCAuAV9bm05AP0mS6Gw==",
+ "engines": {
+ "node": ">=12.0.0"
+ }
+ },
"node_modules/ignore": {
"version": "5.3.1",
"resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz",
diff --git a/package.json b/package.json
index 6b21af2..2d8e510 100644
--- a/package.json
+++ b/package.json
@@ -34,6 +34,7 @@
},
"dependencies": {
"bootstrap-icons": "^1.11.3",
+ "highlight.js": "^11.9.0",
"lit": "^3.1.2"
},
"files": [
diff --git a/src/app/CanvasElement.js b/src/app/CanvasElement.js
new file mode 100644
index 0000000..dd0fae7
--- /dev/null
+++ b/src/app/CanvasElement.js
@@ -0,0 +1,138 @@
+import { LitElement, html, css, nothing } from 'lit';
+
+/**
+ * @class CanvasElement
+ *
+ * This class is used to contain content boxes which are stacked
+ * vertically or horizontally within the canvas.
+ *
+ * @property {Boolean} vertical - Fill the canvas vertically rather than horizontally, default false
+ * @property {String} backgroundColor - Background color of the canvas, light or dark, default light
+ *
+ * @example
+ *
+ * ....
+ * ....
+ * ....
+ *
+ */
+export class CanvasElement extends LitElement {
+ static get localName() {
+ return 'wc-canvas';
+ }
+
+ constructor() {
+ super();
+ this.backgroundColor = 'light';
+ this.vertical = false;
+ }
+
+ static get properties() {
+ return {
+ vertical: { type: Boolean },
+ backgroundColor: { type: String },
+ };
+ }
+
+ static get styles() {
+ return css`
+ div {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ display: flex;
+ }
+
+ /* Any canvas section is in flexbox mode with a fixed size */
+ ::slotted(wc-canvas-section),::slotted(wc-canvas-navbar) {
+ display: flex;
+ justify-content: start;
+ border-style: none;
+ }
+
+ div.vertical {
+ flex-direction: column;
+
+ /* The first section in vertical mode gets a border below */
+ > ::slotted(wc-canvas-navbar:first-child),::slotted(wc-canvas-section:first-child) {
+ min-height: 40px;
+ border-bottom-style: solid;
+ }
+
+ /* The last section in vertical mode gets a border above */
+ > ::slotted(wc-canvas-navbar:last-child),::slotted(wc-canvas-section:last-child) {
+ min-height: 30px;
+ border-top-style: solid;
+ }
+ }
+
+ div:not(.vertical) {
+ flex-direction: row;
+
+ /* The first section in horizontal mode gets a border right */
+ > ::slotted(wc-canvas-navbar:first-child),::slotted(wc-canvas-section:first-child) {
+ min-width: 60px;
+ border-right-style: solid;
+ }
+
+ /* The last section in horizonal mode gets a border left */
+ > ::slotted(wc-canvas-navbar:last-child),::slotted(wc-canvas-section:last-child) {
+ min-width: 60px;
+ border-left-style: solid;
+ }
+ }
+
+ /* Flex containers stretch */
+ ::slotted(wc-canvas-section[flex]) {
+ flex: 999 0;
+ overflow: auto;
+ }
+
+ /* Hidden navbars are hidden */
+ ::slotted(wc-canvas-navbar[hidden]) {
+ display: none;
+ }
+
+ /* Light theme setting colours and border widths */
+ div.bg-color-light {
+ & ::slotted(wc-canvas-navbar), ::slotted(wc-canvas-section) {
+ background-color: var(--light-color);
+ color: var(--dark-color);
+ border-color: var(--grey-20-color);
+ border-width: 1px;
+ }
+ }
+
+ /* Dark theme setting colours and border widths */
+ div.bg-color-dark {
+ & ::slotted(wc-canvas-navbar), ::slotted(wc-canvas-section) {
+ background-color: var(--dark-color);
+ color: var(--light-color);
+ border-color: var(--grey-40-color);
+ border-width: 1px;
+ }
+ }
+ `;
+ }
+
+ render() {
+ return html`
+
+
+
+ `;
+ }
+
+ get className() {
+ const classes = [];
+ if (this.backgroundColor) {
+ classes.push(`bg-color-${this.backgroundColor}`);
+ }
+ if (this.vertical) {
+ classes.push('vertical');
+ }
+ return classes.join(' ');
+ }
+}
diff --git a/src/app/CanvasNavbarElement.js b/src/app/CanvasNavbarElement.js
new file mode 100644
index 0000000..5d1cfdb
--- /dev/null
+++ b/src/app/CanvasNavbarElement.js
@@ -0,0 +1,61 @@
+import { html, css, nothing } from 'lit';
+import { CanvasSectionElement } from './CanvasSectionElement';
+
+/**
+ * @class CanvasNavbarElement
+ *
+ * This class is a navigaton used to contain content boxes which are stacked
+ * vertically or horizontally within the canvas.
+ *
+ * @property {Boolean} hidden - Whether the navigation is hidden, default false
+ *
+ * @example
+ *
+ * ....
+ * ....
+ * ....
+ *
+ */
+export class CanvasNavbarElement extends CanvasSectionElement {
+ static get localName() {
+ return 'wc-canvas-navbar';
+ }
+
+ constructor() {
+ super();
+ this.hidden = false;
+ }
+
+ static get properties() {
+ return {
+ hidden: { type: Boolean },
+ };
+ }
+
+ static get styles() {
+ return css`
+ /* Navbars are flexed to fill the available space */
+ div {
+ display: flex;
+ align-items: start;
+ flex: 1;
+ }
+ `;
+ }
+
+ render() {
+ return html`
+
+
+
+ `;
+ }
+
+ get classes() {
+ const classes = [];
+ if (this.hidden) {
+ classes.push('hidden');
+ }
+ return classes;
+ }
+}
diff --git a/src/app/CanvasSectionElement.js b/src/app/CanvasSectionElement.js
new file mode 100644
index 0000000..8404632
--- /dev/null
+++ b/src/app/CanvasSectionElement.js
@@ -0,0 +1,53 @@
+import { LitElement, html, css, nothing } from 'lit';
+
+/**
+ * @class CanvasSectionElement
+ *
+ * This class is used for content boxes which are stacked
+ * vertically or horizontally within a canvas. The content
+ * boxes can be flexed to fill the available space.
+ *
+ * @property {Boolean} flex - Flex the element to fill the available space, default false
+ *
+ * @example
+ *
+ * ....
+ * ....
+ * ....
+ *
+ */
+export class CanvasSectionElement extends LitElement {
+ static get localName() {
+ return 'wc-canvas-section';
+ }
+
+ static get properties() {
+ return {
+ flex: { type: Boolean },
+ };
+ }
+
+ static get styles() {
+ return css`
+ .flex {
+ flex: 999 0;
+ }
+ `;
+ }
+
+ render() {
+ return html`
+
+
+
+ `;
+ }
+
+ get className() {
+ const classes = [];
+ if (this.flex) {
+ classes.push('flex');
+ }
+ return classes.join(' ');
+ }
+}
diff --git a/src/app/CardElement.js b/src/app/CardElement.js
new file mode 100644
index 0000000..5a87d30
--- /dev/null
+++ b/src/app/CardElement.js
@@ -0,0 +1,90 @@
+import { LitElement, html, css, nothing } from 'lit';
+
+/**
+ * @class CardElement
+ *
+ * This class is used as a information card to display content
+ *
+ * @property {String} backgroundColor - The color theme of the card, default light
+ * @property {Number} width - The width of the card in 1/12th of the available space
+ * @property {Boolean} hidden - Whether the card is hidden, default false
+ *
+ * @example
+ *
+ *
+ *
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
+ labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+ laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+ voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+ non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+ Toggle
+
+
Card
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
+ labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+ laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+ voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+ cupidatat
+ non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+ Popover content
+
+
+
+
Card
+ Background
+ Colour
+
+ Width
+
+
+
+
+ Close
+ Help
+
+
Header
+
Subtitle
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
+ labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+ laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+ voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+ non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+
+
+
+ Close
+
+ The operation was successful
+
+
+
+ Close
+
+ Warning: Something happened
+
+
+
+ Close
+
+ Error: An internal error occurred
+
+
+
+ END
+
-