@zumer/orbit 1.4.5 → 1.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +113 -111
  2. package/dist/orbit.css +2582 -1067
  3. package/dist/orbit.js +62 -88
  4. package/dist/orbit.min.css +2 -1
  5. package/dist/orbit.min.js +9 -3
  6. package/package.json +17 -8
package/README.md CHANGED
@@ -1,170 +1,172 @@
1
+ # Orbit CSS Composer
1
2
 
2
- <p align="center">
3
- <a href="http://zumerlab.github.io/orbit-docs">
4
- <img src="https://raw.githubusercontent.com/zumerlab/orbit-docs/main/public/images/orbithero.gif" width="100%">
5
- </a>
6
- </p>
7
- <p align="center">
8
- <a href="https://zumerlab.github.io/orbit-docs" target="_blank"><b>📚 Docs</b></a> •
9
- <a href="https://github.com/zumerlab/orbit/discussions" target="_blank"><b>💬 Github discussions</b></a> •
10
- <a href="https://t.me/ZumlyCommunity" target="_blank"><b>🧑‍💻 Telegram group</b></a>
11
- </p>
12
- <p align="center">
13
- <b>Use Orbit to create amazing radial UIs using CSS only!</b>
14
- </p>
3
+ **Orbit** is a CSS framework for building radial UIs — gauges, donuts, knobs, pie menus, dashboards — with **CSS only**. No layout JavaScript. Works with plain HTML and any framework (React, Vue, Svelte).
15
4
 
16
5
  <p align="center">
17
- <a href="https://www.npmjs.com/package/@zumer/orbit"><img src="https://img.shields.io/github/package-json/v/zumerlab/orbit"></a>
6
+ <a href="https://zumerlab.github.io/orbit-docs" target="_blank"><strong>🚀 Live showcase &amp; docs</strong></a>
7
+
18
8
  </p>
19
9
 
20
10
  <p align="center">
21
- <a href="#stay-in-orbit"><b>Get involved</b></a>,
22
- place your ⭐ in Orbit! <a href="https://github.com/zumerlab/orbit/stargazers"> <img src="https://img.shields.io/github/stars/zumerlab/orbit.svg?label=%E2%98%85%20Stars&logo=-&style=social"></a>
11
+ <a href="https://www.npmjs.com/package/@zumer/orbit"><img src="https://img.shields.io/npm/v/@zumer/orbit" alt="npm"></a>
12
+ <a href="https://github.com/zumerlab/orbit/stargazers"><img src="https://img.shields.io/github/stars/zumerlab/orbit" alt="Stars"></a>
23
13
  </p>
24
14
 
25
- ## Orbit CSS overview
26
-
27
- **Orbit** is a CSS framework designed for creating radial layouts. It offers simplicity, effectiveness, ease of use, and tremendous versatility for crafting compelling designs. It offers extensive customization options and supports nesting for building intricate designs tailored to your requirements.
15
+ ---
28
16
 
29
17
  ## Why Orbit?
30
18
 
31
- Creating radial UIs generally involves using JavaScript or other programming languages to calculate angles, radii, distances, and more. **Orbit** saves you time and effort by enabling you to build these UIs with just CSS.
32
-
33
- ## Features
34
-
35
- With **Orbit**, you can:
19
+ Radial UIs usually need JavaScript to compute angles, radii, and positions. **Orbit** handles all of that with CSS classes and a couple of Web Components. Drop in two files and start building.
36
20
 
37
- - Build any kind of radial UI using predefined CSS classes that do the heavy lifting.
38
- - Easily compose simple or complex radial designs by combining **Orbit** elements.
39
- - Use **Orbit** alongside other traditional CSS frameworks.
40
- - Get started quickly with our detailed documentation, examples, and guides.
21
+ ## Installation
41
22
 
42
- ## Documentation
23
+ **CDN (fastest):**
43
24
 
44
- Learn all about **Orbit** in our [doc site](https://zumerlab.github.io/orbit-docs)!
25
+ ```html
26
+ <link rel="stylesheet" href="https://unpkg.com/@zumer/orbit@latest/dist/orbit.css">
27
+ <script src="https://unpkg.com/@zumer/orbit@latest/dist/orbit.js"></script>
28
+ ```
45
29
 
46
- ## What is radial UI?
30
+ **npm:**
47
31
 
48
- Radial UI refers to a design paradigm where elements are organized in a circular or radial pattern, diverging from traditional grid-based or linear layouts. This design approach is particularly effective for applications that involve:
32
+ ```bash
33
+ npm install @zumer/orbit
34
+ ```
49
35
 
50
- - **Circular data visualization:** progress bars, pie charts, multi-level pies, gauges, knobs
51
- - **Navigation menus and controls:** radial or pie menus, circular scrolling
52
- - **Dashboards:** smart-home interfaces, car dashboards, infotainment systems
53
- - **Calendars:** circular layouts for scheduling and event tracking
54
- - **Creative art and structures:** mandalas, sci-fi-inspired art, chemical structures
55
- - **Interactive interfaces:** watch faces, dynamic controls for games or tools
36
+ ```js
37
+ import '@zumer/orbit/style'
38
+ import '@zumer/orbit'
39
+ ```
56
40
 
57
- **Characteristics:**
41
+ ---
58
42
 
59
- - **Circular layout:** elements are arranged in a circular or curved pattern.
60
- - **Center-focused:** the center often serves as a focal point.
61
- - **Symmetry:** radial UIs frequently exhibit symmetry, fostering a sense of balance.
62
- - **Angular relationships:** elements are positioned at specific angles relative to one another.
43
+ ## Quick start
63
44
 
64
- **Benefits:**
45
+ Minimal gauge in 10 lines:
65
46
 
66
- - **Aesthetics:** radial designs are visually striking and engaging.
67
- - **Intuitive navigation:** circular layouts simplify navigation and reduce cognitive load.
68
- - **Space efficiency:** radial UIs make efficient use of available screen, ideal for both compact and expansive interfaces.
47
+ ```html
48
+ <div class="bigbang">
49
+ <div class="gravity-spot">
50
+ <div class="orbit-4">
51
+ <o-progress value="72"></o-progress>
52
+ </div>
53
+ </div>
54
+ </div>
55
+ ```
69
56
 
70
- ## Installation
57
+ **Structure:** `bigbang` (container) → `gravity-spot` (center) → `orbit-N` (ring level) → `o-progress` or `o-arc` (the visual element).
71
58
 
72
- **Orbit** comes with just two files: `orbit.css` (or `orbit.min.css`) and `orbit.js` (or `orbit.min.js`).
59
+ ---
73
60
 
74
- ### Obtaining the Orbit files
61
+ ## Core elements
75
62
 
76
- You can get **Orbit** files in three ways:
63
+ | Element | Role |
64
+ |---------|------|
65
+ | `.bigbang` | Root container, sets viewport |
66
+ | `.gravity-spot` | Center of the radial layout; holds rings |
67
+ | `.orbit-1` … `.orbit-7` | Rings at different radii (1 = innermost) |
68
+ | `.satellite` | Item placed on a ring (dot, label, icon) |
69
+ | `<o-arc>` | Arc segment (donut slice, gauge needle, menu sector); `value` 0–100, `shape` e.g. `arrow`, `circle-a` |
70
+ | `<o-progress>` | Simple progress ring |
71
+ | `.vector` | Tick/marker on a ring |
72
+ | `.side` | Stretch content along arc |
73
+ | `.capsule` | Wrapper for content inside satellite; required when satellite holds more than plain text |
77
74
 
78
- #### 1. Download the files
75
+ **Structure rules (avoid visual warnings):**
76
+ - `.bigbang` → direct children: `.gravity-spot` only
77
+ - `.gravity-spot` → direct children: `.orbit`, `.orbit-N`, or `.gravity-spot` only
78
+ - `.satellite` → direct children: `.capsule` or `.gravity-spot` (for nesting) only
79
+ - `.orbit` / `.orbit-N` → do not nest other orbits; orbits live inside gravity-spot
80
+ - `o-arc` and `o-progress` → only work in circular orbits; they are hidden in elliptical shapes
79
81
 
80
- - Download the **CSS file:** [orbit.css](https://unpkg.com/@zumer/orbit@latest/dist/orbit.css) or [orbit.min.css](https://unpkg.com/@zumer/orbit@latest/dist/orbit.min.css).
81
- - Download the **JS file:** [orbit.js](https://unpkg.com/@zumer/orbit@latest/dist/orbit.js) or [orbit.min.js](https://unpkg.com/@zumer/orbit@latest/dist/orbit.min.js).
82
+ **Useful classes:** `range-180`, `range-270`, `range-360` (arc span); `from-180` (start angle); `fit-range` (distribute items); `shrink-50`, `gap-4` (spacing); `at-center` (place satellite in middle).
82
83
 
83
- #### 2. Use a CDN
84
+ ---
84
85
 
85
- - **CSS:**
86
- Uncompressed: [orbit.css](https://unpkg.com/@zumer/orbit@latest/dist/orbit.css)
87
- Minified: [orbit.min.css](https://unpkg.com/@zumer/orbit@latest/dist/orbit.min.css)
86
+ ## Themes
88
87
 
89
- - **JS:**
90
- Uncompressed: [orbit.js](https://unpkg.com/@zumer/orbit@latest/dist/orbit.js)
91
- Minified: [orbit.min.js](https://unpkg.com/@zumer/orbit@latest/dist/orbit.min.js)
88
+ Orbit includes built-in themes. Add the theme class to `.bigbang`:
92
89
 
93
- #### 3. Install via npm or yarn
90
+ | Theme | Class | Description |
91
+ |-------|-------|-------------|
92
+ | **Default** | *(none)* | Transparent borders, gray fills, satellites use `currentColor` |
93
+ | **Cyan** | `theme-cyan` | Cyan satellite borders, cyan vectors/sides, light cyan fills for `o-arc` and `o-progress` |
94
+ | **Developer** | `dev-orbit` | Dashed red borders on orbits and satellites to visualize structure while debugging |
94
95
 
95
- ```sh
96
- npm install @zumer/orbit
97
- ```
96
+ ```html
97
+ <!-- Default (no class) -->
98
+ <div class="bigbang">...</div>
98
99
 
99
- or
100
+ <!-- Cyan theme -->
101
+ <div class="bigbang theme-cyan">...</div>
100
102
 
101
- ```sh
102
- yarn add @zumer/orbit
103
+ <!-- Developer mode for layout debugging -->
104
+ <div class="bigbang dev-orbit">...</div>
103
105
  ```
104
106
 
105
- ### Adding Orbit to your project
106
-
107
- Include the files in your project as follows:
107
+ You can combine themes, e.g. `class="bigbang theme-cyan dev-orbit"`.
108
108
 
109
- ```html
110
- <head>
111
- <link rel="stylesheet" href="path/to/orbit.css">
112
- <script src="path/to/orbit.js"></script>
113
- </head>
114
- ```
109
+ ---
115
110
 
116
- Or via CDN:
111
+ ## Visual aids & development
117
112
 
118
- ```html
119
- <head>
120
- <link rel="stylesheet" href="https://unpkg.com/@zumer/orbit@latest/dist/orbit.css">
121
- <script src="https://unpkg.com/@zumer/orbit@latest/dist/orbit.js"></script>
122
- </head>
123
- ```
113
+ Orbit provides **CSS visual warnings** to catch invalid structure. When rules are broken (e.g. wrong children in `gravity-spot` or `satellite`), Orbit shows a red dotted border, grays out content, and displays a ⚠️ icon.
124
114
 
125
- ## 🏁 Quick start
115
+ Add **`class="dev-orbit"`** to your root container to enable **developer mode**: dashed red borders on `gravity-spot`, `orbit`, and `satellite` to visualize the layout structure. Useful for debugging.
126
116
 
127
117
  ```html
128
- <div class="bigbang">
118
+ <div class="bigbang dev-orbit">
129
119
  <div class="gravity-spot">
130
- <div class="orbit-2 range-180 from-180">
131
- <o-arc shape="circle" class="shrink-50"></o-arc>
132
- </div>
133
- <div class="orbit-3 range-270 ">
134
- <o-arc shape="circle" class="shrink-50"></o-arc>
135
- </div>
120
+ ...
136
121
  </div>
137
122
  </div>
138
123
  ```
139
124
 
125
+ Orbit also checks browser support for `:has()` and trigonometric CSS functions (`cos`, `sin`); unsupported browsers show an upgrade message. See [CSS visual aids](https://zumerlab.github.io/orbit-docs/tools/support) in the full docs.
126
+
127
+ ---
128
+
140
129
  ## Examples
141
130
 
142
- - **A dashboard**
143
- ![demo1](https://raw.githubusercontent.com/zumerlab/orbit-docs/main/public/images/demo1.png)
131
+ Browse examples on the [Orbit docs site](https://zumerlab.github.io/orbit-docs):
144
132
 
145
- - **A watch**
146
- ![demo3](https://raw.githubusercontent.com/zumerlab/orbit-docs/main/public/images/demo3.png)
133
+ | Example | Link |
134
+ |---------|------|
135
+ | Circular timer | [circular_time](https://zumerlab.github.io/orbit-docs/examples/circular_time/) |
136
+ | Progress bars | [progress](https://zumerlab.github.io/orbit-docs/examples/progress/) |
137
+ | Charts (donut, pie, sunburst) | [charts](https://zumerlab.github.io/orbit-docs/examples/charts/) |
138
+ | Gauges (180°, 240°, fuel) | [gauges](https://zumerlab.github.io/orbit-docs/examples/gauges/) |
139
+ | Knobs | [knobs](https://zumerlab.github.io/orbit-docs/examples/knobs/) |
140
+ | Pie menus | [piemenu](https://zumerlab.github.io/orbit-docs/examples/piemenu/) |
141
+ | Watch faces | [watches](https://zumerlab.github.io/orbit-docs/examples/watches/) |
142
+ | Chemical structures | [chemical_structures](https://zumerlab.github.io/orbit-docs/examples/chemical_structures/) |
143
+ | Calendars & time planners | [calendar](https://zumerlab.github.io/orbit-docs/examples/calendar/) |
144
+ | Mandalas | [mandalas](https://zumerlab.github.io/orbit-docs/examples/mandalas/) |
145
+ | Dashboard | [dashboard](https://zumerlab.github.io/orbit-docs/examples/dashboard/) |
146
+ | Abstract orbital map | [abstract_map](https://zumerlab.github.io/orbit-docs/examples/abstract_map/) |
147
147
 
148
- Explore more examples in our [doc site](https://zumerlab.github.io/orbit-docs/examples/progress).
148
+ ---
149
149
 
150
- ## Stay in Orbit
150
+ ## Use cases
151
151
 
152
- There are many ways to **contribute** to **Orbit** development:
152
+ - **Dashboards:** gauges, status rings, KPIs
153
+ - **Automotive / HUD:** speedometers, tachometers, battery, temp
154
+ - **IoT / Smart home:** thermostats, energy rings, scenes
155
+ - **Ops / monitoring:** status rings, uptime gauges
156
+ - **Fitness / health:** activity rings (Move, Exercise, Stand)
157
+ - **Controls:** knobs, radial menus, compass
153
158
 
154
- - [**Contribution guidelines**](https://github.com/zumerlab/orbit/blob/main/CONTRIBUTING.md): This guide outlines how you can contribute to Orbit, help us test and improve it, and share your experiences with the community.
155
- - [**GitHub discussions**](https://github.com/zumerlab/orbit/discussions): Engage with other contributors, ask questions, and share your experiences.
156
- - [**Telegram group**](https://t.me/ZumlyCommunity): Join our Telegram group for real-time discussions and updates.
159
+ ---
157
160
 
158
- ## Special thanks to our contributors
161
+ ## Resources
159
162
 
160
- <a href="https://github.com/zumerlab/orbit-docs/graphs/contributors">
161
- <img src="https://contrib.rocks/image?repo=zumerlab/orbit-docs" />
162
- </a>
163
+ - [Full documentation](https://zumerlab.github.io/orbit-docs) — elements, tools, advanced examples
164
+ - [Contributing](CONTRIBUTING.md)
165
+ - [GitHub Discussions](https://github.com/zumerlab/orbit/discussions)
166
+ - [Telegram](https://t.me/ZumlyCommunity)
163
167
 
164
- <a href="https://github.com/zumerlab/orbit/graphs/contributors">
165
- <img src="https://contrib.rocks/image?repo=zumerlab/orbit" />
166
- </a>
168
+ ---
167
169
 
168
- ## License
170
+ ## License
169
171
 
170
- [MIT](https://github.com/zumerlab/orbit/blob/main/LICENSE)
172
+ [MIT](LICENSE)