edirom-window

https://github.com/edirom/edirom-window

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.4%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: Edirom
License: mit
Language: JavaScript
Default Branch: main
Size: 40 KB

Statistics

Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Releases: 0

Created about 2 years ago · Last pushed almost 2 years ago

Metadata Files

Readme License Citation

Edirom Windows Web Component

This web component displays and creates new windows using the winbox library. It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. No compilation or building is necessary to use the web component. The component uses a fork of the WinBox library which is like the component itself based on plain JavaScript.

Note: This repository only contains the bare JavaScript-based component, there is a separate demo suite for web components developed in the Edirom Online Reloaded project, where the component can be seen and tested.

License

The edirom-windows.js comes with the license MIT. The imported winbox library comes with the license Apache-2.0.

How to use this web component

Clone the repository into a directory of your choice
Include the path to the web component's JavaScript file into the <head> an HTML page html <script src="path/to/edirom-windows.js"></script>
Include a custom element (this is specified and can be processed by the component) into the <body> of the HTML page. The attributes of the custom element are used as parameters at initialization of the component and changing them (manually or programmatically) can control the components state and behaviour during runtime. The state changes of the web component are communicated outwards via custom events (called 'communicate-{change-type}-update'). The component/document that instantiates the web component (its parent) can listen (via event listeners which have to be implemented individually) and react to the communicated state changes if necessary. The separation of inward communication (via custom element's attributes) and outward communication (via custom events) is esp. necessary to handle frequently populated information like currentTime of the audio player and avoid interference between reading and writing info about the component's state. html <edirom-windows set="" add="" remove="" arrange=""></edirom-windows>

Parameters

Note: All attribute values are strings internally, the data type information below indicates the necessary format of the attribute value.

The window definition mentioned below are based on the available WinBox options.

| Parameter | Data type | Description | default | |---------------|---|---|---| | set | json | initiating windows (removing all existing ones); array of window definitions: [{"title": "Window title", "html": "<h1>Window heading</h1><p>Lorem ipsum</p>"}, ... ] | | | add | json | adding windows (keeping all existing ones); array of window definitions: [{"title": "Window title", "html": "<h1>Window heading</h1><p>Lorem ipsum</p>"}, ... ] | | | remove | string | id of an existing window that will be removed (normally sth like "winbox-1") | | | arrange | string | arranging open windows on available screen; available options/values: horizontal, vertical | |

Owner

Name: Virtueller Forschungsverbund Edirom
Login: Edirom
Kind: organization
Location: Germany

Website: https://www.edirom.de
Repositories: 83
Profile: https://github.com/Edirom

Citation (CITATION.cff)

cff-version: 1.2.0
title: Edirom Windows Web Component
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Hizkiel
    family-names: Alemayehu
    email: hizkiel.alemayehu@uni-paderborn.de
    affiliation: Universität Paderborn
  - given-names: Daniel
    family-names: Jettka
    email: daniel.jettka@uni-paderborn.de
    affiliation: Universität Paderborn
    orcid: 'https://orcid.org/0000-0002-2375-2227'
repository-code: 'https://github.com/Edirom/edirom-window'
abstract: >-
  This web component displays and creates HTML divs with window functionality using the winbox library. 
  It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. 
  No compilation or building is necessary to use the web component. 
  The component uses a fork of the WinBox library which is like the component itself based on plain JavaScript.
license: MIT

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science