Browse Source

DOC: Added copyright, minor functional, README

master
chris 1 month ago
parent
commit
ea9261446d
  1. 22
      README.md
  2. 2
      generate_single_file.js
  3. 1
      src/componentAncestry/addStyleAndFunctions.js
  4. 5
      src/context/framework-controls.js
  5. 9
      src/extensions/extension.js
  6. 6
      src/modifications/contextMenu.js
  7. 10
      src/modifications/dragAndDrop.js
  8. 4
      src/modifier.js
  9. 6
      src/sizeSide/shapes.js
  10. 2
      src/sizeSide/siding.js

22
README.md

@ -1,7 +1,7 @@
# jpc-like-websites # jpc-like-websites
> Jetpack Compose 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 feels really straight forward
and intuitive for me. and intuitive for me.
Furthermore I personally found it more readable Furthermore I personally found it more readable
@ -13,20 +13,28 @@ to build those websites more or less fast (easy)
and reliable. and reliable.
While they do look the way I intend them to. 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 After developing some minor apps with Jetpack Compose,
the components are build/structured. I liked a lot about the way the components are build/structured.
The reusability and so on... The reusability and so on...
Further I love to write code in a "method-chaning" kind of way: Further I love to write code in a "method-chaning" kind of way:
Every line is a chain-link concerning one particular task, Every line is a chain-link concerning one particular task,
the IDE offers an overview of possibilities. the IDE offers an overview of possibilities.
Method-chaining is more or less native in Kotlin. It makes even more sence concidering the git-line-wise change detection.
Logical support for git-line-wise change detection.
After some (very little) searching, After some (very little) searching,
I choose to give it a couple of hours I choose to give it a couple of hours
and develop a small "lib" to enable myself to do exactly that. 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, Javascript is by far not my strongest field,
typescript even less. typescript even less.
@ -36,4 +44,4 @@ you have been warned.
```sh ```sh
sh join_js_files.sh sh join_js_files.sh
``` ```

2
generate_single_file.js

@ -13,7 +13,7 @@ class FileDependecy {
} }
/** /**
* Ordered Access Object * Object Access Object
* purely convienience * purely convienience
*/ */
class OAO { class OAO {

1
src/componentAncestry/addStyleAndFunctions.js

@ -37,7 +37,6 @@ class StyleAndScriptStoringComponent extends ModifiableComponent {
this._styleClassesExtStore = ExtStoreType.CENTRALIZED_DOC_HEAD this._styleClassesExtStore = ExtStoreType.CENTRALIZED_DOC_HEAD
.setOverwriteBehaviour(OverwriteBehaviour.REPLACE); .setOverwriteBehaviour(OverwriteBehaviour.REPLACE);
this._stylesExtStore = ExtStoreType.INTERNALIZED_WITHIN this._stylesExtStore = ExtStoreType.INTERNALIZED_WITHIN
.setOverwriteBehaviour(OverwriteBehaviour.REPLACE); .setOverwriteBehaviour(OverwriteBehaviour.REPLACE);

5
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( function frameworkControlPanel(
extensions = [] extensions = []
) { ) {

9
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 { class CompelExtension {
/** /**
* @type {string} * @type {string}

6
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 = { const DefaultContextMenu = {
openContextMenuAction: function (identifier, refPos) { openContextMenuAction: function (identifier, refPos) {

10
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({ const EventDrag = Object.freeze({
OVER: "over", OVER: "over",
START: "start", START: "start",
@ -6,7 +12,9 @@ const EventDrag = Object.freeze({
LEAVE: "leave" LEAVE: "leave"
}); });
/**
* Defines default functions to setup a drag/drop behaviour
*/
class DragAndDropImplementation { class DragAndDropImplementation {
_isMngmtElNeeded; _isMngmtElNeeded;

4
src/modifier.js

@ -199,7 +199,11 @@ class Modifier {
* Adds the modifications of the given Modifier to current Modifier. * Adds the modifications of the given Modifier to current Modifier.
* This is especailly used in the cases of extending existing/pre defined * This is especailly used in the cases of extending existing/pre defined
* Components. * Components.
*
* CAUTION matching existing modifications will be overwritten. * CAUTION matching existing modifications will be overwritten.
*
* @todo finish second parameter "modifications" - logic
*
* @param modifier The "new" Modifier * @param modifier The "new" Modifier
* @returns {Modifier} The "old/current" Modifier, * @returns {Modifier} The "old/current" Modifier,
* extended with the modifications of the given Modifier. * extended with the modifications of the given Modifier.

6
src/sizeSide/shapes.js

@ -3,12 +3,6 @@
* URL: https://git.labos.goip.de/chris/jpc-like-websites * URL: https://git.labos.goip.de/chris/jpc-like-websites
* @copyright by its creator Christian Martin * @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 * @extends DirectionUnitDependentAttribute

2
src/sizeSide/siding.js

@ -5,7 +5,7 @@
*/ */
/** /**
* * Enum providing predefined set of Size-Units
*/ */
const SizeUnits = Object.freeze({ const SizeUnits = Object.freeze({
PIXEL: "px", PIXEL: "px",

Loading…
Cancel
Save