ui-optago 1.2.0 → 1.2.1

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 (5) hide show
  1. package/README.md +178 -178
  2. package/index.html +1474 -1414
  3. package/package.json +30 -30
  4. package/ui-optago.css +99 -18
  5. package/ui-optago.js +786 -708
package/README.md CHANGED
@@ -1,178 +1,178 @@
1
- # UI Óptago
2
-
3
- [![npm](https://img.shields.io/npm/v/ui-optago.svg)](https://www.npmjs.com/package/ui-optago)
4
- [![license](https://img.shields.io/npm/l/ui-optago.svg)](./LICENSE)
5
-
6
- Design System da **[Óptago](https://optago.com.br)**: componentes UI em **CSS puro** + **JS vanilla**, sem build obrigatório. Tema escuro por padrão, tema claro automático, verde-lima `#C0FF6B` e ciano `#6BE0FF` como cores de destaque, e o octógono da marca como motivo visual.
7
-
8
- ## Instalação
9
-
10
- **Via npm:**
11
-
12
- ```bash
13
- npm install ui-optago
14
- ```
15
-
16
- ```html
17
- <link rel="stylesheet" href="node_modules/ui-optago/ui-optago.css">
18
- <script src="node_modules/ui-optago/ui-optago.js"></script>
19
- ```
20
-
21
- **Via CDN** (não precisa instalar nada, adicione ao `<head>`):
22
-
23
- ```html
24
- <link rel="stylesheet" href="https://unpkg.com/ui-optago/ui-optago.css">
25
- <script src="https://unpkg.com/ui-optago/ui-optago.js"></script>
26
- ```
27
-
28
- Em produção, fixe a versão para não sofrer quebras em atualizações:
29
-
30
- ```html
31
- <link rel="stylesheet" href="https://unpkg.com/ui-optago@1.0.0/ui-optago.css">
32
- <script src="https://unpkg.com/ui-optago@1.0.0/ui-optago.js"></script>
33
- ```
34
-
35
- > Também funciona via jsDelivr: `https://cdn.jsdelivr.net/npm/ui-optago/ui-optago.css`
36
-
37
- **Ou copie os arquivos direto** (`ui-optago.css` e `ui-optago.js`) para o seu projeto:
38
-
39
- ```html
40
- <head>
41
- <link rel="stylesheet" href="ui-optago.css">
42
- <!-- Carregue no <head> SEM defer: o JS aplica o tema salvo antes do
43
- primeiro paint (evita flash de tema errado) e injeta sozinho as
44
- Google Fonts e os ícones Phosphor. -->
45
- <script src="ui-optago.js"></script>
46
- </head>
47
- ```
48
-
49
- ## Showcase
50
-
51
- Abra **`ui-optago.html`** no navegador: todos os componentes com botões **Copiar** (HTML pronto) e **Ver código**.
52
-
53
- ## Selo "Desenvolvido por Óptago"
54
-
55
- Bloco pronto para o rodapé de qualquer site feito pela Óptago, mesmo sites que **não** usam o resto do design system. São dois arquivos HTML autocontidos (`<style>` + markup, sem depender de nada do site hospedeiro): `optago-credit-dark.html` (chip escuro translúcido, para fundos escuros ou neutros) e `optago-credit-light.html` (chip claro translúcido, para fundos claros). Escolha o que combina com o fundo onde o selo vai ficar.
56
-
57
- **Via CDN**, sem copiar nada:
58
-
59
- ```html
60
- <div id="optago-credit"></div>
61
- <script>
62
- fetch('https://unpkg.com/ui-optago/optago-credit-dark.html')
63
- .then(r => r.text())
64
- .then(html => document.getElementById('optago-credit').innerHTML = html);
65
- </script>
66
- ```
67
-
68
- Fixe a versão em produção: `https://unpkg.com/ui-optago@1.2.0/optago-credit-dark.html` (troque `dark` por `light` conforme o caso). Também funciona via jsDelivr: `https://cdn.jsdelivr.net/npm/ui-optago/optago-credit-dark.html`.
69
-
70
- **Ou copie o arquivo direto** para o seu projeto e sirva/inclua localmente (ex. `include` no PHP, import estático, etc.); cada arquivo já vem com essas instruções comentadas no topo.
71
-
72
- ## Estrutura de layout (app shell)
73
-
74
- Header, footer e sidebar (à direita) fixos: só o `.op-main` rola. A sidebar colapsa no desktop (só ícones + tooltip) e vira drawer no mobile.
75
-
76
- ```html
77
- <body class="op-app">
78
- <div class="op-app-body">
79
- <header class="op-header">...</header>
80
- <main class="op-main">CONTEÚDO ROLÁVEL</main>
81
- <footer class="op-footer">...</footer>
82
- </div>
83
- <aside class="op-sidebar">
84
- <nav class="op-sidebar-nav">
85
- <a class="op-nav-item" href="#secao">
86
- <i class="ph ph-palette"></i>
87
- <span class="op-nav-text">Título</span>
88
- <span class="op-nav-tooltip">Título</span>
89
- </a>
90
- </nav>
91
- </aside>
92
- </body>
93
- ```
94
-
95
- ## Componentes
96
-
97
- Todas as classes usam o prefixo `op-`; estados usam `is-` (`is-open`, `is-active`, `is-error`...).
98
-
99
- | Grupo | Classes principais |
100
- |---|---|
101
- | Botões | `op-btn` + `op-btn-primary/secondary/success/danger/warning/info`, ghosts, `op-btn-sm/lg`, `op-btn-icon`, `op-btn-group`, `is-loading` |
102
- | Badges | `op-badge` + `op-badge-brand/info/success/warning/danger`, `op-badge-pill`, `op-dot` |
103
- | Alertas | `op-alert` + `op-alert-info/success/warning/danger`, `data-op-dismiss` |
104
- | Formulários | `op-field`, `op-label`, `op-input`, `op-select`, `op-textarea`, `op-check`, `op-switch`, `op-range`, `op-input-group`, estados `is-error/is-success` |
105
- | Tabelas | `op-table` (+ `op-table-hover/striped`) e Tabulator com tema Óptago via `OptagoUI.tabulator()` |
106
- | Cards | `op-card`, `op-card-hover`, `op-stat` (KPI) |
107
- | Feedback | `op-progress`, `op-spinner`, `op-skeleton` (+ `-thumb/-title/-btn/-badge/-row`), toasts |
108
- | Navegação | `op-tabs` (linha, `op-tabs-pills`, `op-tabs-vertical`), `op-accordion`, `op-breadcrumb`, `op-pagination`, `op-dropdown` |
109
- | Overlays | `op-modal` (+ `op-modal-drawer`, `op-modal-centered`, `op-modal-sm/lg`), tooltip via `data-op-tip` |
110
- | Extras | `op-timeline` (marcadores octogonais), `op-glow` (manchas verde-lima desfocadas de fundo), `op-avatar` |
111
-
112
- ## Comportamentos via atributos `data-op-*`
113
-
114
- Nenhum JS manual necessário, basta o atributo:
115
-
116
- | Atributo | Ação |
117
- |---|---|
118
- | `data-op-theme-toggle` | Alterna tema claro/escuro (persiste em `localStorage`) |
119
- | `data-op-sidebar-toggle` | Colapsa/expande a sidebar |
120
- | `data-op-sidebar-mobile` | Abre/fecha o drawer no mobile |
121
- | `data-op-modal-open="#id"` | Abre o modal |
122
- | `data-op-modal-close` | Fecha o modal (dentro dele; ESC e clique no fundo também fecham) |
123
- | `data-op-tab="nome"` | Botão de aba (com `data-op-tab-group` no container) |
124
- | `data-op-dropdown-toggle` | Abre/fecha o `.op-dropdown` |
125
- | `data-op-dismiss` | Remove o `.op-alert` pai |
126
- | `data-op-tip="texto"` | Tooltip em CSS puro (variante `.op-tip-bottom`) |
127
- | `data-op-copy="#sel"` / `data-op-code="#sel"` | Copiar HTML / ver código (showcase) |
128
-
129
- ## API JavaScript (`window.OptagoUI`)
130
-
131
- ```js
132
- OptagoUI.toast('Deploy concluído!', 'success'); // 'success' | 'error' | 'warning' | 'info'
133
- OptagoUI.openModal('#meuModal');
134
- OptagoUI.closeModal('#meuModal');
135
- OptagoUI.setTheme('light'); // 'dark' | 'light'
136
- OptagoUI.toggleSidebar();
137
-
138
- // Tabela avançada (carrega o Tabulator do CDN sob demanda, já com tema Óptago)
139
- OptagoUI.tabulator('#minhaTabela', {
140
- layout: 'fitColumns',
141
- pagination: true,
142
- data: [...],
143
- columns: [...]
144
- }).then(tabela => { /* instância Tabulator */ });
145
- ```
146
-
147
- ## Tokens (CSS Custom Properties)
148
-
149
- Personalize sobrescrevendo as variáveis no seu próprio CSS:
150
-
151
- ```css
152
- :root {
153
- --op-accent: #C0FF6B; /* verde-lima da marca */
154
- --op-cyan: #6BE0FF; /* ciano: cor secundária da marca */
155
- --op-info: #3B82F6;
156
- --op-success: #10B981;
157
- --op-warning: #F59E0B;
158
- --op-danger: #EF4444;
159
- --op-radius: 12px;
160
- /* superfícies: --op-bg, --op-panel, --op-border, --op-text, --op-muted... */
161
- }
162
- ```
163
-
164
- Tema claro = classe `light` no `<html>` (gerenciada automaticamente pelo JS).
165
-
166
- ### Tema compartilhado entre subdomínios
167
-
168
- Por padrão, a escolha de tema fica em `localStorage`, isolada por app. Para vários apps sob o mesmo domínio compartilharem a mesma escolha (ex.: `app1.seusite.com` e `app2.seusite.com`), adicione `data-op-theme-domain` no `<script>` da lib:
169
-
170
- ```html
171
- <script src="ui-optago.js" data-op-theme-domain=".seusite.com"></script>
172
- ```
173
-
174
- Com isso, o tema passa a ser salvo também num cookie com `Domain=.seusite.com` (além do `localStorage`, mantido como fallback), lido por qualquer subdomínio que carregue a lib com o mesmo atributo. Use um domínio de verdade, começando com `.`; não use o domínio de outro site.
175
-
176
- ## Dependências em runtime
177
-
178
- Injetadas automaticamente pelo `ui-optago.js` (CDN): Google Fonts (Chakra Petch, Inter, JetBrains Mono) e Phosphor Icons. Tabulator só é baixado se `OptagoUI.tabulator()` for chamado.
1
+ # UI Óptago
2
+
3
+ [![npm](https://img.shields.io/npm/v/ui-optago.svg)](https://www.npmjs.com/package/ui-optago)
4
+ [![license](https://img.shields.io/npm/l/ui-optago.svg)](./LICENSE)
5
+
6
+ Design System da **[Óptago](https://optago.com.br)**: componentes UI em **CSS puro** + **JS vanilla**, sem build obrigatório. Tema escuro por padrão, tema claro automático, verde-lima `#C0FF6B` e ciano `#6BE0FF` como cores de destaque, e o octógono da marca como motivo visual.
7
+
8
+ ## Instalação
9
+
10
+ **Via npm:**
11
+
12
+ ```bash
13
+ npm install ui-optago
14
+ ```
15
+
16
+ ```html
17
+ <link rel="stylesheet" href="node_modules/ui-optago/ui-optago.css">
18
+ <script src="node_modules/ui-optago/ui-optago.js"></script>
19
+ ```
20
+
21
+ **Via CDN** (não precisa instalar nada, adicione ao `<head>`):
22
+
23
+ ```html
24
+ <link rel="stylesheet" href="https://unpkg.com/ui-optago/ui-optago.css">
25
+ <script src="https://unpkg.com/ui-optago/ui-optago.js"></script>
26
+ ```
27
+
28
+ Em produção, fixe a versão para não sofrer quebras em atualizações:
29
+
30
+ ```html
31
+ <link rel="stylesheet" href="https://unpkg.com/ui-optago@1.0.0/ui-optago.css">
32
+ <script src="https://unpkg.com/ui-optago@1.0.0/ui-optago.js"></script>
33
+ ```
34
+
35
+ > Também funciona via jsDelivr: `https://cdn.jsdelivr.net/npm/ui-optago/ui-optago.css`
36
+
37
+ **Ou copie os arquivos direto** (`ui-optago.css` e `ui-optago.js`) para o seu projeto:
38
+
39
+ ```html
40
+ <head>
41
+ <link rel="stylesheet" href="ui-optago.css">
42
+ <!-- Carregue no <head> SEM defer: o JS aplica o tema salvo antes do
43
+ primeiro paint (evita flash de tema errado) e injeta sozinho as
44
+ Google Fonts e os ícones Phosphor. -->
45
+ <script src="ui-optago.js"></script>
46
+ </head>
47
+ ```
48
+
49
+ ## Showcase
50
+
51
+ Abra **`ui-optago.html`** no navegador: todos os componentes com botões **Copiar** (HTML pronto) e **Ver código**.
52
+
53
+ ## Selo "Desenvolvido por Óptago"
54
+
55
+ Bloco pronto para o rodapé de qualquer site feito pela Óptago, mesmo sites que **não** usam o resto do design system. São dois arquivos HTML autocontidos (`<style>` + markup, sem depender de nada do site hospedeiro): `optago-credit-dark.html` (chip escuro translúcido, para fundos escuros ou neutros) e `optago-credit-light.html` (chip claro translúcido, para fundos claros). Escolha o que combina com o fundo onde o selo vai ficar.
56
+
57
+ **Via CDN**, sem copiar nada:
58
+
59
+ ```html
60
+ <div id="optago-credit"></div>
61
+ <script>
62
+ fetch('https://unpkg.com/ui-optago/optago-credit-dark.html')
63
+ .then(r => r.text())
64
+ .then(html => document.getElementById('optago-credit').innerHTML = html);
65
+ </script>
66
+ ```
67
+
68
+ Fixe a versão em produção: `https://unpkg.com/ui-optago@1.2.1/optago-credit-dark.html` (troque `dark` por `light` conforme o caso). Também funciona via jsDelivr: `https://cdn.jsdelivr.net/npm/ui-optago/optago-credit-dark.html`.
69
+
70
+ **Ou copie o arquivo direto** para o seu projeto e sirva/inclua localmente (ex. `include` no PHP, import estático, etc.); cada arquivo já vem com essas instruções comentadas no topo.
71
+
72
+ ## Estrutura de layout (app shell)
73
+
74
+ Header, footer e sidebar (à direita) fixos: só o `.op-main` rola. A sidebar colapsa no desktop (só ícones + tooltip) e vira drawer no mobile.
75
+
76
+ ```html
77
+ <body class="op-app">
78
+ <div class="op-app-body">
79
+ <header class="op-header">...</header>
80
+ <main class="op-main">CONTEÚDO ROLÁVEL</main>
81
+ <footer class="op-footer">...</footer>
82
+ </div>
83
+ <aside class="op-sidebar">
84
+ <nav class="op-sidebar-nav">
85
+ <a class="op-nav-item" href="#secao">
86
+ <i class="ph ph-palette"></i>
87
+ <span class="op-nav-text">Título</span>
88
+ <span class="op-nav-tooltip">Título</span>
89
+ </a>
90
+ </nav>
91
+ </aside>
92
+ </body>
93
+ ```
94
+
95
+ ## Componentes
96
+
97
+ Todas as classes usam o prefixo `op-`; estados usam `is-` (`is-open`, `is-active`, `is-error`...).
98
+
99
+ | Grupo | Classes principais |
100
+ |---|---|
101
+ | Botões | `op-btn` + `op-btn-primary/secondary/success/danger/warning/info`, ghosts, `op-btn-sm/lg`, `op-btn-icon`, `op-btn-group`, `is-loading` |
102
+ | Badges | `op-badge` + `op-badge-brand/info/success/warning/danger`, `op-badge-pill`, `op-dot` |
103
+ | Alertas | `op-alert` + `op-alert-info/success/warning/danger`, `data-op-dismiss` |
104
+ | Formulários | `op-field`, `op-label`, `op-input`, `op-select`, `op-textarea`, `op-check`, `op-switch`, `op-range`, `op-input-group`, estados `is-error/is-success` |
105
+ | Tabelas | `op-table` (+ `op-table-hover/striped`) e Tabulator com tema Óptago via `OptagoUI.tabulator()` |
106
+ | Cards | `op-card`, `op-card-hover`, `op-stat` (KPI) |
107
+ | Feedback | `op-progress`, `op-spinner`, `op-skeleton` (+ `-thumb/-title/-btn/-badge/-row`), toasts |
108
+ | Navegação | `op-tabs` (linha, `op-tabs-pills`, `op-tabs-vertical`), `op-accordion`, `op-breadcrumb`, `op-pagination`, `op-dropdown` |
109
+ | Overlays | `op-modal` (+ `op-modal-drawer`, `op-modal-centered`, `op-modal-sm/lg`), tooltip via `data-op-tip` |
110
+ | Extras | `op-timeline` (marcadores octogonais), `op-glow` (manchas verde-lima desfocadas de fundo), `op-avatar` |
111
+
112
+ ## Comportamentos via atributos `data-op-*`
113
+
114
+ Nenhum JS manual necessário, basta o atributo:
115
+
116
+ | Atributo | Ação |
117
+ |---|---|
118
+ | `data-op-theme-toggle` | Alterna tema claro/escuro (persiste em `localStorage`) |
119
+ | `data-op-sidebar-toggle` | Colapsa/expande a sidebar |
120
+ | `data-op-sidebar-mobile` | Abre/fecha o drawer no mobile |
121
+ | `data-op-modal-open="#id"` | Abre o modal |
122
+ | `data-op-modal-close` | Fecha o modal (dentro dele; ESC e clique no fundo também fecham) |
123
+ | `data-op-tab="nome"` | Botão de aba (com `data-op-tab-group` no container) |
124
+ | `data-op-dropdown-toggle` | Abre/fecha o `.op-dropdown` |
125
+ | `data-op-dismiss` | Remove o `.op-alert` pai |
126
+ | `data-op-tip="texto"` | Tooltip em CSS puro (variante `.op-tip-bottom`) |
127
+ | `data-op-copy="#sel"` / `data-op-code="#sel"` | Copiar HTML / ver código (showcase) |
128
+
129
+ ## API JavaScript (`window.OptagoUI`)
130
+
131
+ ```js
132
+ OptagoUI.toast('Deploy concluído!', 'success'); // 'success' | 'error' | 'warning' | 'info'
133
+ OptagoUI.openModal('#meuModal');
134
+ OptagoUI.closeModal('#meuModal');
135
+ OptagoUI.setTheme('light'); // 'dark' | 'light'
136
+ OptagoUI.toggleSidebar();
137
+
138
+ // Tabela avançada (carrega o Tabulator do CDN sob demanda, já com tema Óptago)
139
+ OptagoUI.tabulator('#minhaTabela', {
140
+ layout: 'fitColumns',
141
+ pagination: true,
142
+ data: [...],
143
+ columns: [...]
144
+ }).then(tabela => { /* instância Tabulator */ });
145
+ ```
146
+
147
+ ## Tokens (CSS Custom Properties)
148
+
149
+ Personalize sobrescrevendo as variáveis no seu próprio CSS:
150
+
151
+ ```css
152
+ :root {
153
+ --op-accent: #C0FF6B; /* verde-lima da marca */
154
+ --op-cyan: #6BE0FF; /* ciano: cor secundária da marca */
155
+ --op-info: #3B82F6;
156
+ --op-success: #10B981;
157
+ --op-warning: #F59E0B;
158
+ --op-danger: #EF4444;
159
+ --op-radius: 12px;
160
+ /* superfícies: --op-bg, --op-panel, --op-border, --op-text, --op-muted... */
161
+ }
162
+ ```
163
+
164
+ Tema claro = classe `light` no `<html>` (gerenciada automaticamente pelo JS).
165
+
166
+ ### Tema compartilhado entre subdomínios
167
+
168
+ Por padrão, a escolha de tema fica em `localStorage`, isolada por app. Para vários apps sob o mesmo domínio compartilharem a mesma escolha (ex.: `app1.seusite.com` e `app2.seusite.com`), adicione `data-op-theme-domain` no `<script>` da lib:
169
+
170
+ ```html
171
+ <script src="ui-optago.js" data-op-theme-domain=".seusite.com"></script>
172
+ ```
173
+
174
+ Com isso, o tema passa a ser salvo também num cookie com `Domain=.seusite.com` (além do `localStorage`, mantido como fallback), lido por qualquer subdomínio que carregue a lib com o mesmo atributo. Use um domínio de verdade, começando com `.`; não use o domínio de outro site.
175
+
176
+ ## Dependências em runtime
177
+
178
+ Injetadas automaticamente pelo `ui-optago.js` (CDN): Google Fonts (Chakra Petch, Inter, JetBrains Mono) e Phosphor Icons. Tabulator só é baixado se `OptagoUI.tabulator()` for chamado.