From ea9261446d0b8f924162c6f2c3e7120d1ae66d1f Mon Sep 17 00:00:00 2001 From: chris Date: Sun, 2 Mar 2025 15:00:18 +0100 Subject: [PATCH] DOC: Added copyright, minor functional, README --- README.md | 22 +++++++++++++------ generate_single_file.js | 2 +- src/componentAncestry/addStyleAndFunctions.js | 1 - src/context/framework-controls.js | 5 ++++- src/extensions/extension.js | 9 ++++++++ src/modifications/contextMenu.js | 6 +++-- src/modifications/dragAndDrop.js | 10 ++++++++- src/modifier.js | 4 ++++ src/sizeSide/shapes.js | 6 ----- src/sizeSide/siding.js | 2 +- 10 files changed, 47 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ccbf2d6..6d9284e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # jpc-like-websites > Jetpack Compose like websites -The building method of Jetpack Compose (for android), +The building method of Jetpack Compose (for e.g. android), feels really straight forward and intuitive for me. Furthermore I personally found it more readable @@ -13,20 +13,28 @@ to build those websites more or less fast (easy) and reliable. While they do look the way I intend them to. -After developing some minor apps with Jetpack Compose I liked a lot about the way -the components are build/structured. +After developing some minor apps with Jetpack Compose, +I liked a lot about the way the components are build/structured. The reusability and so on... Further I love to write code in a "method-chaning" kind of way: Every line is a chain-link concerning one particular task, the IDE offers an overview of possibilities. -Method-chaining is more or less native in Kotlin. -Logical support for git-line-wise change detection. +It makes even more sence concidering the git-line-wise change detection. After some (very little) searching, I choose to give it a couple of hours and develop a small "lib" to enable myself to do exactly that. -> Develop jetpack compose like components in html/javascript. +> Develop html/javascript components in a "jetpack compose like" manner. + +BUT it is not inteded to be or do more than that. +The lib/framework is supposed to help to build/define/construct components +or furhter single page applications. +It is not meant to be a framework like react, vue, angular ... the list goes on. +The closest comparison is actually typescript, +it is supposed to build html, js, and css. +If desired, it can generate the entire page (html-file) +without the framework itself. Javascript is by far not my strongest field, typescript even less. @@ -36,4 +44,4 @@ you have been warned. ```sh sh join_js_files.sh -``` \ No newline at end of file +``` diff --git a/generate_single_file.js b/generate_single_file.js index 12c42f3..83aea23 100644 --- a/generate_single_file.js +++ b/generate_single_file.js @@ -13,7 +13,7 @@ class FileDependecy { } /** - * Ordered Access Object + * Object Access Object * purely convienience */ class OAO { diff --git a/src/componentAncestry/addStyleAndFunctions.js b/src/componentAncestry/addStyleAndFunctions.js index e2c5c44..60d1b6e 100644 --- a/src/componentAncestry/addStyleAndFunctions.js +++ b/src/componentAncestry/addStyleAndFunctions.js @@ -37,7 +37,6 @@ class StyleAndScriptStoringComponent extends ModifiableComponent { this._styleClassesExtStore = ExtStoreType.CENTRALIZED_DOC_HEAD .setOverwriteBehaviour(OverwriteBehaviour.REPLACE); - this._stylesExtStore = ExtStoreType.INTERNALIZED_WITHIN .setOverwriteBehaviour(OverwriteBehaviour.REPLACE); diff --git a/src/context/framework-controls.js b/src/context/framework-controls.js index bef543d..4baa475 100644 --- a/src/context/framework-controls.js +++ b/src/context/framework-controls.js @@ -1,7 +1,10 @@ /** - * + * This file is part of the jps-like-websites lib + * URL: https://git.labos.goip.de/chris/jpc-like-websites + * @copyright by its creator Christian Martin */ + function frameworkControlPanel( extensions = [] ) { diff --git a/src/extensions/extension.js b/src/extensions/extension.js index 2f3d17b..9532273 100644 --- a/src/extensions/extension.js +++ b/src/extensions/extension.js @@ -1,3 +1,12 @@ +/** + * This file is part of the jps-like-websites lib + * URL: https://git.labos.goip.de/chris/jpc-like-websites + * @copyright by its creator Christian Martin + */ + +/** + * Defines an extension that can be added to the jpclw-framework + */ class CompelExtension { /** * @type {string} diff --git a/src/modifications/contextMenu.js b/src/modifications/contextMenu.js index d4d0705..4222f10 100644 --- a/src/modifications/contextMenu.js +++ b/src/modifications/contextMenu.js @@ -1,9 +1,11 @@ /** - * + * This file is part of the jps-like-websites lib + * URL: https://git.labos.goip.de/chris/jpc-like-websites + * @copyright by its creator Christian Martin */ /** - * + * Default implementation of a contextmenu-behaviour */ const DefaultContextMenu = { openContextMenuAction: function (identifier, refPos) { diff --git a/src/modifications/dragAndDrop.js b/src/modifications/dragAndDrop.js index aeca67d..759e024 100644 --- a/src/modifications/dragAndDrop.js +++ b/src/modifications/dragAndDrop.js @@ -1,3 +1,9 @@ +/** + * This file is part of the jps-like-websites lib + * URL: https://git.labos.goip.de/chris/jpc-like-websites + * @copyright by its creator Christian Martin + */ + const EventDrag = Object.freeze({ OVER: "over", START: "start", @@ -6,7 +12,9 @@ const EventDrag = Object.freeze({ LEAVE: "leave" }); - +/** + * Defines default functions to setup a drag/drop behaviour + */ class DragAndDropImplementation { _isMngmtElNeeded; diff --git a/src/modifier.js b/src/modifier.js index 3211301..d0a3307 100644 --- a/src/modifier.js +++ b/src/modifier.js @@ -199,7 +199,11 @@ class Modifier { * Adds the modifications of the given Modifier to current Modifier. * This is especailly used in the cases of extending existing/pre defined * Components. + * * CAUTION matching existing modifications will be overwritten. + * + * @todo finish second parameter "modifications" - logic + * * @param modifier The "new" Modifier * @returns {Modifier} The "old/current" Modifier, * extended with the modifications of the given Modifier. diff --git a/src/sizeSide/shapes.js b/src/sizeSide/shapes.js index 9f3f1b2..3f6728d 100644 --- a/src/sizeSide/shapes.js +++ b/src/sizeSide/shapes.js @@ -3,12 +3,6 @@ * URL: https://git.labos.goip.de/chris/jpc-like-websites * @copyright by its creator Christian Martin */ -/** - * This file is part of the jps-like-websites lib - * URL: https://git.labos.goip.de/chris/jpc-like-websites - * COPYRIGHT and LICENCE are owned by its creator Christian Martin - * Copy, altering or distribution without the allowance of the owner are prohibited - */ /** * @extends DirectionUnitDependentAttribute diff --git a/src/sizeSide/siding.js b/src/sizeSide/siding.js index 9ba9127..1d5b416 100644 --- a/src/sizeSide/siding.js +++ b/src/sizeSide/siding.js @@ -5,7 +5,7 @@ */ /** - * + * Enum providing predefined set of Size-Units */ const SizeUnits = Object.freeze({ PIXEL: "px",