Skip to content

Zheng-Bote/rz_wc-lib

Repository files navigation

rz-wc-lib

Web Components library

Report Issue Request Feature

MIT License GitHub release (latest by date)


Table of Contents


Description

HTML5 Typescript Svelte.js CSS3

Web Components library

Features

  • advanced-super-extra-special feature xyz


  • OSS and license

  • works as designed

  • no bugs


  • runs on modern Browsers

Web Components

  • rz-breadcrumbs : dynamic generated breadcrumbs
  • rz-button-top : shows a button "goto top" if viewport is invisible
  • rz-clock : Displays an analog clock with the given timezone and locale.
  • rz-cookie-alert : sets a website cookie, if accepted by user
  • rz-datetime : shows date / time in the choosen timezone and format
  • rz-fontsize : choose and change website fontsize (S, M, L, XL)
  • rz-footer : horizontal footer with 3 defineable sections
  • rz-header : horizontal header with brand logo and site functions (change language, toogle dark/light mode, change fontsize, login...)
  • rz-imprint: loads the imprint / legal-notice based on the current language
  • rz-language : switch website language
  • rz-loginform : standardized login-form
  • rz-modal : shows a modal window with given header-, body-, footer-text
  • rz-navmenu : Button-based navigation menu
  • rz-online : shows if client is on-/offline (for PWA)
  • rz-theme : toogle dark-/light-mode

(back to top)

Status

GitHub Created At GitHub Release Date GitHub release (latest by date)

Status Status

GitHub Issues GitHub Pull Requests

Documentation

Tip

see also: www.hase-zheng.net/ for examples

Usage

Declaration of Web-Component

Declare the web-component script in html-header or somewhere in body

<script type="module" src="/assets/rz-xxx.js"></script>

Initialization of Web-Component

initalizize the web-component, in some cases with optional attribute=value

<rz-xxx optional="value" optional="value"></rz-xxx>

Development

Dependencies

Note

All licenses are therefore Open Source.

  • Vite (tested with 6.2.0)
  • Typescript (tested with 5.7.2)
  • Svelte (tested with 5.20.2)
  • sveltejs/vite-plugin-svelte (tested with 5.0.3)

folder structure

.
├── .github
│   ├── actions
│   │   └── doctoc
│   │       ├── README.md
│   │       ├── action.yml
│   │       └── dist
│   │           ├── index.js
│   │           ├── index.js.map
│   │           ├── licenses.txt
│   │           └── sourcemap-register.js
│   └── workflows
│       ├── ghp-call_Readme.yml
│       ├── ghp-create_doctoc.yml
│       ├── ghp-markdown_index.yml
│       ├── repo-actions_docu.yml
│       ├── repo-call_Readme.yml
│       ├── repo-create_doctoc.yml_
│       ├── repo-create_doctoc_md.yml
│       └── repo-create_tree_readme.yml
├── .gitignore
├── .vscode
│   └── extensions.json
├── LICENSE
├── README.md
├── index.html
├── package-lock.json
├── package.json
├── public
│   ├── css
│   │   ├── coding.css
│   │   ├── index.css
│   │   ├── link.css
│   │   ├── text.css
│   │   └── theme.css
│   ├── i18n
│   │   ├── de.json
│   │   └── en.json
│   ├── img
│   │   ├── icons
│   │   │   ├── dontpanic.svg
│   │   │   ├── favicon.ico
│   │   │   ├── favicon.svg
│   │   │   ├── glasses-outline.svg
│   │   │   ├── home-outline.svg
│   │   │   ├── information-outline.svg
│   │   │   ├── language-outline.svg
│   │   │   ├── log-in-outline.svg
│   │   │   ├── mail-open-outline.svg
│   │   │   ├── moon-outline.svg
│   │   │   ├── nok.svg
│   │   │   ├── ok.svg
│   │   │   ├── search-outline.svg
│   │   │   ├── sunny-outline.svg
│   │   │   └── sync-outline.svg
│   │   ├── rz-address_mail.svg
│   │   ├── rz-address_mail_white.svg
│   │   ├── rz-address_postal.png
│   │   ├── rz-clock_bg.jpg
│   │   ├── rz-qr-code.svg
│   │   └── zheng_bote.svg
│   ├── imprint_de.htm
│   ├── imprint_en.htm
│   ├── index.html
│   ├── js
│   │   └── i18n.js
│   ├── legal.html
│   ├── login.html
│   ├── rz-navmenu.json
│   ├── template.htm
│   └── wc-docs
│       ├── index.html
│       ├── rz-breadcrumbs.html
│       ├── rz-button-top.html
│       ├── rz-clock.html
│       ├── rz-cookiealert.html
│       ├── rz-datetime.html
│       ├── rz-fontsize.html
│       ├── rz-footer.html
│       ├── rz-header.html
│       ├── rz-imprint.html
│       ├── rz-language.html
│       ├── rz-loginform.html
│       ├── rz-modal.html
│       ├── rz-navmenu.html
│       ├── rz-online.html
│       └── rz-theme.html
├── src
│   ├── App.svelte
│   ├── lib
│   │   ├── Counter.svelte
│   │   ├── rz-breadcrumbs.js
│   │   ├── rz-button-top.svelte
│   │   ├── rz-clock.js
│   │   ├── rz-cookie-alert.js
│   │   ├── rz-datetime.svelte
│   │   ├── rz-fontsize.svelte
│   │   ├── rz-footer.svelte
│   │   ├── rz-gallery.svelte
│   │   ├── rz-header.svelte
│   │   ├── rz-imagecard.svelte
│   │   ├── rz-imprint.svelte
│   │   ├── rz-language.svelte
│   │   ├── rz-loginform.svelte
│   │   ├── rz-modal.svelte
│   │   ├── rz-navmenu.svelte
│   │   ├── rz-online.svelte
│   │   └── rz-theme.svelte
│   ├── main.ts
│   └── vite-env.d.ts
├── svelte.config.js
├── tree.bak
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.ts

16 directories, 100 files

(back to top)

Authors and License

License

MIT License

Copyright (c) 2025 ZHENG Robert

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    https://choosealicense.com/licenses/mit/

Authors

  • Zheng Robert

Code Contributors

Contributors

Zheng Robert


🖖

(back to top)

About

Web Components library

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •