ui-optago 1.2.2 → 1.2.4
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.
- package/README.md +197 -178
- package/index.html +1799 -1474
- package/llms.txt +18 -7
- package/package.json +1 -1
- package/ui-optago.css +2453 -2295
- package/ui-optago.js +897 -805
package/README.md
CHANGED
|
@@ -1,178 +1,197 @@
|
|
|
1
|
-
# UI Óptago
|
|
2
|
-
|
|
3
|
-
[](https://www.npmjs.com/package/ui-optago)
|
|
4
|
-
[](./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.
|
|
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
|
-
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
| `data-op-
|
|
120
|
-
| `data-op-sidebar-
|
|
121
|
-
| `data-op-
|
|
122
|
-
| `data-op-modal-
|
|
123
|
-
| `data-op-
|
|
124
|
-
| `data-op-
|
|
125
|
-
| `data-op-
|
|
126
|
-
| `data-op-
|
|
127
|
-
| `data-op-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
OptagoUI.
|
|
134
|
-
OptagoUI.
|
|
135
|
-
OptagoUI.
|
|
136
|
-
OptagoUI.
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
:
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
1
|
+
# UI Óptago
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/ui-optago)
|
|
4
|
+
[](./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.4/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
|
+
| Visibilidade | `op-mobile-only` (só abaixo de 1024px, onde a sidebar vira drawer), `op-desktop-only` (some abaixo de 1024px); ambas usam `!important`, então vencem o `display` de outra classe |
|
|
111
|
+
| Extras | `op-timeline` (marcadores octogonais), `op-glow` (manchas verde-lima desfocadas de fundo), `op-avatar` |
|
|
112
|
+
|
|
113
|
+
## Comportamentos via atributos `data-op-*`
|
|
114
|
+
|
|
115
|
+
Nenhum JS manual necessário, basta o atributo:
|
|
116
|
+
|
|
117
|
+
| Atributo | Ação |
|
|
118
|
+
|---|---|
|
|
119
|
+
| `data-op-theme-toggle` | Alterna tema claro/escuro (persiste em `localStorage`) |
|
|
120
|
+
| `data-op-sidebar-toggle` | Colapsa/expande a sidebar |
|
|
121
|
+
| `data-op-sidebar-mobile` | Abre/fecha o drawer no mobile |
|
|
122
|
+
| `data-op-modal-open="#id"` | Abre o modal |
|
|
123
|
+
| `data-op-modal-close` | Fecha o modal (dentro dele; ESC e clique no fundo também fecham) |
|
|
124
|
+
| `data-op-tab="nome"` | Botão de aba (com `data-op-tab-group` no container) |
|
|
125
|
+
| `data-op-dropdown-toggle` | Abre/fecha o `.op-dropdown` |
|
|
126
|
+
| `data-op-dismiss` | Remove o `.op-alert` pai |
|
|
127
|
+
| `data-op-tip="texto"` | Tooltip em CSS puro (variante `.op-tip-bottom`) |
|
|
128
|
+
| `data-op-copy="#sel"` / `data-op-code="#sel"` | Copiar HTML / ver código (showcase) |
|
|
129
|
+
|
|
130
|
+
## API JavaScript (`window.OptagoUI`)
|
|
131
|
+
|
|
132
|
+
```js
|
|
133
|
+
OptagoUI.toast('Deploy concluído!', 'success'); // 'success' | 'error' | 'warning' | 'info'
|
|
134
|
+
OptagoUI.openModal('#meuModal');
|
|
135
|
+
OptagoUI.closeModal('#meuModal');
|
|
136
|
+
OptagoUI.setTheme('light'); // 'dark' | 'light'
|
|
137
|
+
OptagoUI.toggleSidebar();
|
|
138
|
+
OptagoUI.customize({ accent: '#FF6B00', radius: '6px' }); // sobrescreve tokens (--op-*) em runtime
|
|
139
|
+
|
|
140
|
+
// Tour guiado (carrega driver.js do CDN sob demanda, já com tema Óptago)
|
|
141
|
+
OptagoUI.tour([
|
|
142
|
+
{ element: '#meu-elemento', popover: { title: 'Passo 1', description: 'Texto explicativo.' } },
|
|
143
|
+
{ element: '#outro', popover: { title: 'Passo 2', description: 'Continue aqui.' } },
|
|
144
|
+
{ popover: { title: 'Pronto!', description: 'Tour concluído.' } } // sem element = modal central
|
|
145
|
+
]).then(d => { /* instância driver.js, opcional */ });
|
|
146
|
+
|
|
147
|
+
// Tabela avançada (carrega o Tabulator do CDN sob demanda, já com tema Óptago)
|
|
148
|
+
OptagoUI.tabulator('#minhaTabela', {
|
|
149
|
+
layout: 'fitColumns',
|
|
150
|
+
pagination: true,
|
|
151
|
+
data: [...],
|
|
152
|
+
columns: [...]
|
|
153
|
+
}).then(tabela => { /* instância Tabulator */ });
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Tokens (CSS Custom Properties)
|
|
157
|
+
|
|
158
|
+
Personalize sobrescrevendo as variáveis no seu próprio CSS:
|
|
159
|
+
|
|
160
|
+
```css
|
|
161
|
+
:root {
|
|
162
|
+
--op-accent: #C0FF6B; /* verde-lima da marca */
|
|
163
|
+
--op-cyan: #6BE0FF; /* ciano: cor secundária da marca */
|
|
164
|
+
--op-info: #3B82F6;
|
|
165
|
+
--op-success: #10B981;
|
|
166
|
+
--op-warning: #F59E0B;
|
|
167
|
+
--op-danger: #EF4444;
|
|
168
|
+
--op-radius: 12px;
|
|
169
|
+
/* superfícies: --op-bg, --op-panel, --op-border, --op-text, --op-muted... */
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
Ou em runtime via JS (ex.: cor por tenant/cliente vinda de uma API), sem precisar de `<style>` próprio:
|
|
174
|
+
|
|
175
|
+
```js
|
|
176
|
+
OptagoUI.customize({ accent: '#FF6B00', cyan: '#00B8D9', radius: '6px' });
|
|
177
|
+
// nomes curtos viram --op-*, mas o nome completo também funciona:
|
|
178
|
+
OptagoUI.customize({ '--op-accent': '#FF6B00' });
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Lista completa de tokens e exemplos ao vivo: seção **Customizando** do [showcase](index.html#customizando).
|
|
182
|
+
|
|
183
|
+
Tema claro = classe `light` no `<html>` (gerenciada automaticamente pelo JS).
|
|
184
|
+
|
|
185
|
+
### Tema compartilhado entre subdomínios
|
|
186
|
+
|
|
187
|
+
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:
|
|
188
|
+
|
|
189
|
+
```html
|
|
190
|
+
<script src="ui-optago.js" data-op-theme-domain=".seusite.com"></script>
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
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.
|
|
194
|
+
|
|
195
|
+
## Dependências em runtime
|
|
196
|
+
|
|
197
|
+
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.
|