From 1a67e0758d386bbc2195c9948a4856706449691d Mon Sep 17 00:00:00 2001 From: Gene Date: Thu, 1 Jun 2023 17:39:34 +0200 Subject: [PATCH] Updated docs. --- docs/feed/rss.xml | 80 +++++++++---------- .../documentation/getting_started/index.html | 2 +- docs/search-index.json | 2 +- docs/search-list.json | 2 +- docs/service-worker.js | 2 +- docs/service-worker.js.map | 2 +- docs/sitemap.xml | 8 +- .../documentation/getting_started/index.md | 7 +- 8 files changed, 52 insertions(+), 53 deletions(-) diff --git a/docs/feed/rss.xml b/docs/feed/rss.xml index bfd3973..3adc3f4 100644 --- a/docs/feed/rss.xml +++ b/docs/feed/rss.xml @@ -7,8 +7,8 @@ en - Thu, 01 Jun 2023 17:16:11 +0200 - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 zuix.js https://zuixjs.org/images/icons/icon-152x152.png @@ -19,7 +19,7 @@ https://zuixjs.org/pages/documentation/ https://zuixjs.org/pages/documentation/ Documentation section - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -28,7 +28,7 @@ https://zuixjs.org/pages/documentation/api/ https://zuixjs.org/pages/documentation/api/ API classes documentation, Zuix, ComponentContext, ContextController, ZxQuery. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -37,7 +37,7 @@ https://zuixjs.org/pages/documentation/active_refresh/ https://zuixjs.org/pages/documentation/active_refresh/ About scoped scripts, dependencies, refresh-handlers, built-in @ handlers, custom handlers. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -46,7 +46,7 @@ https://zuixjs.org/pages/documentation/api/helpers/Utils_dom/ https://zuixjs.org/pages/documentation/api/helpers/Utils_dom/ zUIx.js API documentation, Namespace: dom - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -55,7 +55,7 @@ https://zuixjs.org/pages/documentation/api/helpers/Logger/ https://zuixjs.org/pages/documentation/api/helpers/Logger/ zUIx.js API documentation, Class: Logger - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -64,7 +64,7 @@ https://zuixjs.org/pages/documentation/api/helpers/TaskQueue/ https://zuixjs.org/pages/documentation/api/helpers/TaskQueue/ zUIx.js API documentation, Class: TaskQueue - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -73,7 +73,7 @@ https://zuixjs.org/pages/documentation/api/helpers/Utils.dom/ https://zuixjs.org/pages/documentation/api/helpers/Utils.dom/ zUIx.js API documentation, Namespace: dom - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -82,7 +82,7 @@ https://zuixjs.org/pages/documentation/api/helpers/Utils/ https://zuixjs.org/pages/documentation/api/helpers/Utils/ zUIx.js API documentation, Namespace: Utils - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -91,7 +91,7 @@ https://zuixjs.org/pages/documentation/api/helpers/ZxQuery/ https://zuixjs.org/pages/documentation/api/helpers/ZxQuery/ zUIx.js API documentation, Class: ZxQuery - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -100,7 +100,7 @@ https://zuixjs.org/pages/documentation/api/helpers/ZxQueryStatic/ https://zuixjs.org/pages/documentation/api/helpers/ZxQueryStatic/ zUIx.js API documentation, Class: ZxQueryStatic - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -109,7 +109,7 @@ https://zuixjs.org/pages/documentation/api/localizer/Localizer/ https://zuixjs.org/pages/documentation/api/localizer/Localizer/ zUIx.js API documentation, Class: Localizer - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -118,7 +118,7 @@ https://zuixjs.org/pages/documentation/api/observable/ObjectObserver/ https://zuixjs.org/pages/documentation/api/observable/ObjectObserver/ zUIx.js API documentation, Class: ObjectObserver - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -127,7 +127,7 @@ https://zuixjs.org/pages/documentation/api/observable/ObservableListener/ https://zuixjs.org/pages/documentation/api/observable/ObservableListener/ zUIx.js API documentation, Class: ObservableListener - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -136,7 +136,7 @@ https://zuixjs.org/pages/documentation/api/observable/ObservableObject/ https://zuixjs.org/pages/documentation/api/observable/ObservableObject/ zUIx.js API documentation, Class: ObservableObject - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -145,7 +145,7 @@ https://zuixjs.org/pages/documentation/api/zuix/ActiveRefresh/ https://zuixjs.org/pages/documentation/api/zuix/ActiveRefresh/ zUIx.js API documentation, Class: ActiveRefresh - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -154,7 +154,7 @@ https://zuixjs.org/pages/documentation/api/zuix/Componentizer/ https://zuixjs.org/pages/documentation/api/zuix/Componentizer/ zUIx.js API documentation, Class: Componentizer - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -163,7 +163,7 @@ https://zuixjs.org/pages/documentation/api/zuix/ViewObserver/ https://zuixjs.org/pages/documentation/api/zuix/ViewObserver/ zUIx.js API documentation, Class: ViewObserver - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -172,7 +172,7 @@ https://zuixjs.org/pages/documentation/controller/ https://zuixjs.org/pages/documentation/controller/ Controller implementation types, lifecycle, options, events. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -181,25 +181,16 @@ https://zuixjs.org/search/ https://zuixjs.org/search/ Search this website - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 - - Getting started - https://zuixjs.org/pages/documentation/getting_started/ - https://zuixjs.org/pages/documentation/getting_started/ - Creating a new project using *zuix.js* CLI tool and bare library usage. - Thu, 01 Jun 2023 17:16:11 +0200 - - - Playground https://zuixjs.org/playground/ https://zuixjs.org/playground/ Client-side embeddable components editor. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -208,7 +199,7 @@ https://zuixjs.org/pages/documentation/cli/ https://zuixjs.org/pages/documentation/cli/ Command Line Interface, creating a new projects, pages, templates and components. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -217,7 +208,7 @@ https://zuixjs.org/pages/documentation/api/zuix/ComponentContext/ https://zuixjs.org/pages/documentation/api/zuix/ComponentContext/ zUIx.js API documentation, Class: ComponentContext - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -226,7 +217,7 @@ https://zuixjs.org/pages/documentation/api/zuix/ContextController/ https://zuixjs.org/pages/documentation/api/zuix/ContextController/ zUIx.js API documentation, Class: ContextController - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -235,7 +226,7 @@ https://zuixjs.org/pages/documentation/api/zuix/ControllerInstance/ https://zuixjs.org/pages/documentation/api/zuix/ControllerInstance/ zUIx.js API documentation, Class: ControllerInstance - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -244,7 +235,7 @@ https://zuixjs.org/pages/documentation/api/zuix/Zuix/ https://zuixjs.org/pages/documentation/api/zuix/Zuix/ zUIx.js API documentation, Class: Zuix - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -253,7 +244,7 @@ https://zuixjs.org/pages/documentation/about/ https://zuixjs.org/pages/documentation/about/ zuix.js is a lightweight library for creating component based websites and applications by using standard HTML, CSS and JavaScript. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -262,7 +253,7 @@ https://zuixjs.org/pages/documentation/component/ https://zuixjs.org/pages/documentation/component/ Components, custom elements, shadow DOM, standalone components, the <em>default</em> component. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -271,7 +262,7 @@ https://zuixjs.org/pages/documentation/view/ https://zuixjs.org/pages/documentation/view/ View, Data binding, binding adapters, accessibility, behaviors, events. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 @@ -280,9 +271,18 @@ https://zuixjs.org/pages/documentation/context_options/ https://zuixjs.org/pages/documentation/context_options/ Component's loading options, event handlers, styles, priority, theming. - Thu, 01 Jun 2023 17:16:11 +0200 + Thu, 01 Jun 2023 17:38:33 +0200 + + Getting started + https://zuixjs.org/pages/documentation/getting_started/ + https://zuixjs.org/pages/documentation/getting_started/ + Creating a new project using *zuix.js* CLI tool and bare library usage. + Thu, 01 Jun 2023 17:38:33 +0200 + + + diff --git a/docs/pages/documentation/getting_started/index.html b/docs/pages/documentation/getting_started/index.html index 69c47f6..bad7de7 100644 --- a/docs/pages/documentation/getting_started/index.html +++ b/docs/pages/documentation/getting_started/index.html @@ -480,7 +480,7 @@ } [z-context="menu-drawer"]:focus { outline: none; -}

Getting started

See zuix.js in action using the online playground, where is possible to create and download ready to use components directly in the browser!

sports_soccer Playground

Bare library usage on an existing site

zuix.js can also be used on an existing website project by including the library directly in the HTML page or a JavaScript module:

JsDeliver

<script src="https://cdn.jsdelivr.net/npm/zuix-dist@1.1.28"></script>

or as a module:

<script type="module" src="https://cdn.jsdelivr.net/npm/zuix-dist@1.1.28/js/zuix.module.min.js"></script>

or as a dependency of another module:

// file: my-class.module.js
+}

Getting started

See zuix.js in action using the online playground, where is possible to create and download ready to use components directly in the browser!

sports_soccer Playground

Bare library usage on an existing site

As a regular script:

JsDeliver

<script src="https://cdn.jsdelivr.net/npm/zuix-dist@1.1.28"></script>

As a module:

<script type="module" src="https://cdn.jsdelivr.net/npm/zuix-dist@1.1.28/js/zuix.module.min.js"></script>

As a dependency of another module:

// file: my-class.module.js
 import 'https://cdn.jsdelivr.net/npm/zuix-dist@1.1.28/js/zuix.module.min.js'; 

NPM

npm install zuix-dist

then copy the library from node_modules/zuix-dist/js to your project's js folder and include it in your HTML page or JavaScript module.

Creating a new web project using the CLI

The zuix-cli tool can be used to create a new web project, the only prerequisite is that node.js must be installed first.

# Create a new website project named 'my-new-webapp'
 npx zuix new my-new-webapp

A new folder named my-new-webapp will be created containing all files required to run the starter project.

From the new folder we can now start the local server that will watch, build and serve the web application files (by default at http://localhost:8080).

cd my-new-webapp
 npx zuix start

Read more about all other zuix command functionality from zuix-cli documentation page.

You can also try the web-starter template live on StackBlitz.

GitHub logo
JavaScript library for component-based websites and applications.