@split-window/angular 0.0.0-stage → 0.2.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Lucas Dornelas
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,242 @@
1
- # Temporary Holding Version
1
+ # @split-window/angular
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Adaptador Angular do SplitWindow: abas em containers, com a API do `NgbOffcanvas`/`NgbModal` (`open(content, options)` devolve uma ref) e vários containers registrados por chave. Inclui barra de abas, numeração, drag and drop com o Angular CDK, tela cheia e containers fixos nas bordas da janela.
4
+
5
+ Requer Angular 22. Peer dependencies: `@angular/core`, `@angular/common`, `@angular/cdk` e `rxjs`. Não depende de ng-bootstrap nem de Bootstrap.
6
+
7
+ ## Instalação
8
+
9
+ ```bash
10
+ npm install @split-window/angular @split-window/core @angular/cdk
11
+ ```
12
+
13
+ Importe tudo de `@split-window/angular`: o pacote reexporta os tipos e erros do core.
14
+
15
+ ## Configuração
16
+
17
+ `provideSplitWindows()` registra o `SplitWindowManager` e o `SplitContainerRegistry`. Eles **não** são `providedIn: 'root'`: sem o provider, injetar qualquer um deles ou usar a diretiva falha com o erro de injeção do Angular. Nenhum container existe por padrão.
18
+
19
+ ```ts
20
+ // app.config.ts
21
+ import { inject, provideAppInitializer, type ApplicationConfig } from '@angular/core';
22
+ import { SplitContainerRegistry, provideSplitWindows } from '@split-window/angular';
23
+
24
+ export const appConfig: ApplicationConfig = {
25
+ providers: [
26
+ provideSplitWindows(),
27
+ provideAppInitializer(() => {
28
+ // só body-right, sem limite de abas, como container padrão
29
+ inject(SplitContainerRegistry).useBodyContainers();
30
+ }),
31
+ ],
32
+ };
33
+ ```
34
+
35
+ O registry pode ser injetado sozinho na inicialização, sem criar o manager. Ele só guarda configuração: abrir, fechar e tela cheia são do controller (`SplitWindowController`), exposto pelo manager.
36
+
37
+ Tudo é provider e pode ser trocado por uma subclasse: `provideSplitWindows({ engine: MinhaEngine, controller: MeuController })`. Modos (`inline`, `push`, `overlay`, registrados, por classe ou função), motores de animação (`@split-window/css-animation`, `@split-window/keyframes-animation`) e o fechamento sincronizado da última aba estão em [Modos e animação](../../docs/guides/modos-e-animacao.md).
38
+
39
+ ## Abrir um componente ou template
40
+
41
+ ```ts
42
+ import { SplitWindowManager } from '@split-window/angular';
43
+
44
+ export class ContratosComponent {
45
+ private readonly manager = inject(SplitWindowManager);
46
+
47
+ abrir(id: number) {
48
+ const ref = this.manager.open(ContratoDetalheComponent, {
49
+ title: 'Contrato',
50
+ inputs: { id }, // setInput no componente
51
+ containerKey: 'direito', // sem valor: container padrão
52
+ });
53
+ ref.result.then(
54
+ (valor) => console.log('fechou com', valor),
55
+ () => {},
56
+ );
57
+ }
58
+ }
59
+ ```
60
+
61
+ Um `TemplateRef` recebe o `SplitActiveWindow` como `$implicit` e como `window`:
62
+
63
+ ```html
64
+ <ng-template #nota let-win>
65
+ <p>{{ win.label() }} em {{ win.containerKey() }}</p>
66
+ <button (click)="win.close('ok')">Fechar</button>
67
+ </ng-template>
68
+ ```
69
+
70
+ ```ts
71
+ readonly nota = viewChild.required<TemplateRef<unknown>>('nota');
72
+ abrirNota() { this.manager.open(this.nota(), { title: 'Nota' }); }
73
+ ```
74
+
75
+ ### `SplitWindowManager`
76
+
77
+ | Membro | Descrição |
78
+ | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
79
+ | `open(content, options?)` | Abre um componente (`Type<T>`) ou `TemplateRef`. Devolve `SplitWindowRef<T>`. |
80
+ | `dismissAll({ containerKey?, reason?, force? })` | Fechar tudo sequencial. Resolve com `{ closed, kept }`. |
81
+ | `hasOpenWindows(containerKey?)` | Se há abas abertas (num container ou em qualquer um). |
82
+ | `getTabs(containerKey)` | Abas de um container, na ordem da barra. |
83
+ | `expandContainer(key)` / `restoreContainer(key)` | Tela cheia de um container (pelo controller; o registry só guarda configuração). |
84
+ | `isContainerOpen(key)` / `isContainerExpanded(key)` / `getExpandedContainer()` | Estado dos containers. |
85
+ | `containerStateChanged` | Container aberto, fechado, expandido ou restaurado. |
86
+ | `containerTransitions` | Transições de abrir/fechar (`start`, `running`, `done`, `cancelled`). |
87
+ | `registry` | O mesmo `SplitContainerRegistry` injetável. |
88
+ | `tabMoved`, `tabRejected` | Eventos globais de movimentação e de rejeição por limite. |
89
+
90
+ ## Opções de abertura (`SplitWindowOptions`)
91
+
92
+ | Opção | Tipo | Padrão | Descrição |
93
+ | -------------- | ----------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ |
94
+ | `containerKey` | `string` | container padrão | Container de destino. Chave desconhecida lança `SplitContainerNotFoundError`. |
95
+ | `title` | `string` | `labels.defaultTitle` (`'Nova aba'`) | Título; a numeração é por grupo + título. |
96
+ | `groupKey` | `string` | grupo default | Separa a numeração. |
97
+ | `activate` | `boolean` | `true` | Ativa a aba. A primeira aba de um container vazio é sempre ativada. |
98
+ | `closable` | `boolean` | `true` | `false` esconde o X e o fechar tudo pula a aba. O código ainda pode fechá-la. |
99
+ | `canClose` | `SplitCloseGuard` | — | Verificação a cada pedido de fechamento: `boolean`, `Promise<boolean>` ou `Observable<boolean>`. |
100
+ | `canMove` | `(target: { containerKey; index? }) => boolean` | — | Veta movimentos. `index` fica ausente durante o arraste. |
101
+ | `inputs` | `Record<string, unknown>` | — | Inputs aplicados com `setInput` no componente. |
102
+ | `injector` | `Injector` | `EnvironmentInjector` do manager | Injector pai da aba. Passe `inject(Injector)` para herdar providers de quem abre. |
103
+
104
+ Os valores padrão de `activate` e `closable` podem ser trocados no `provideSplitWindows({ activate, closable })`.
105
+
106
+ ## `SplitWindowRef`
107
+
108
+ `id`, `result` (resolve no `close`, rejeita no `dismiss`), `rejected`, `componentInstance`, `containerKey`, `title`, `label`, `groupKey`, `closable`, `isActive`, `isOpen`; métodos `close(result?, { force? })`, `dismiss(reason?, { force? })`, `activate()`, `moveTo(key, index?)`, `setTitle()`, `setClosable()`, `setCanClose()`, `setCanMove()`, `setInputData(data)` (`setInput` só nos inputs que o componente declara, pelo nome da propriedade ou pelo alias; ignora o resto e valores `undefined`), `attachTo(subscription)` (liga a aba a uma `Subscription`: fechar a aba encerra a subscription, e encerrar a subscription com a aba aberta faz `dismiss`), `asRequest()` (Observable que emite o resultado do `close` e completa; completa sem valor no `dismiss`; cancelar a inscrição antes faz `dismiss` da aba); eventos descritos no [guia de eventos](../../docs/guides/eventos.md).
109
+
110
+ ## `SplitActiveWindow`
111
+
112
+ Injetado no componente (ou no contexto do template) aberto como aba:
113
+
114
+ ```ts
115
+ export class ContratoDetalheComponent {
116
+ private readonly window = inject(SplitActiveWindow);
117
+ readonly form = inject(FormBuilder).group({ nome: [''] });
118
+
119
+ constructor() {
120
+ this.window.setCanClose(() => !this.form.dirty || confirm('Descartar as alterações?'));
121
+ }
122
+
123
+ salvar() {
124
+ this.window.setTitle(`Contrato ${this.form.value.nome}`);
125
+ this.window.close('salvo');
126
+ }
127
+ }
128
+ ```
129
+
130
+ | Membro | Descrição |
131
+ | ---------------------------------------------- | --------------------------------------------------------------------------------------- |
132
+ | `containerKey`, `title`, `label`, `isActive` | Signals. O container é um signal porque a aba pode mudar de container depois de criada. |
133
+ | `close()`, `dismiss()` | Mesmo comportamento da ref (passam pelo `canClose`, salvo com `force`). |
134
+ | `setTitle()`, `setClosable()`, `setCanClose()` | Mesmo comportamento da ref. |
135
+ | `ref` | A `SplitWindowRef` da aba. |
136
+
137
+ Não guarde no construtor valores que dependem do container: depois de mover, eles ficariam desatualizados. Leia `containerKey()`.
138
+
139
+ ## Diretiva `splitContainer`
140
+
141
+ ```html
142
+ <div
143
+ splitContainer="direito"
144
+ [splitContainerDefault]="true"
145
+ [splitContainerOptions]="{ maxTabs: 5 }"
146
+ ></div>
147
+ ```
148
+
149
+ - Registra o host no `ngOnInit` e desregistra no destroy. Desregistrar fecha as abas com `dismiss('container-removed')`, sem `canClose`: um container dentro de um `@if` ou de uma rota perde as abas quando sai da tela.
150
+ - `splitContainerDefault` define (ou remove) o container padrão.
151
+ - `splitContainerOptions` é lido no registro. Trocar a chave desregistra a antiga e registra a nova.
152
+ - Por código: `registry.registerContainer(key, element, options)`.
153
+
154
+ Opções de container (`maxTabs`, `onFull`, `onReject`, `closeWhenEmpty`, `label`, `closedDropZone`, `closedDropZoneAnchor`, `expand`) estão nos [guias](../../docs/guides/README.md).
155
+
156
+ ## Tema: CSS custom properties
157
+
158
+ Todas as cores, tamanhos e camadas são variáveis. Os padrões ficam em `:where(:root)`, com especificidade zero: qualquer seletor da aplicação vence, independentemente da ordem das folhas de estilo. Sobrescreva em `:root` para a aplicação toda, ou num ancestral para um container só (os containers do body ficam direto no `body`).
159
+
160
+ ```css
161
+ :root {
162
+ --split-tab-active-indicator: #8250df;
163
+ --split-tab-height: 32px;
164
+ }
165
+ ```
166
+
167
+ | Variável | Padrão |
168
+ | ------------------------------ | ----------------------------------- |
169
+ | `--split-bg` | `#ffffff` |
170
+ | `--split-fg` | `#1f2328` |
171
+ | `--split-muted-fg` | `#59636e` |
172
+ | `--split-border` | `#d1d9e0` |
173
+ | `--split-strip-bg` | `#f6f8fa` |
174
+ | `--split-tab-bg` | `transparent` |
175
+ | `--split-tab-hover-bg` | `#eaeef2` |
176
+ | `--split-tab-active-bg` | `#ffffff` |
177
+ | `--split-tab-active-indicator` | `#0969da` |
178
+ | `--split-focus-ring` | `#0969da` |
179
+ | `--split-drop-highlight` | `#0969da` |
180
+ | `--split-drop-zone-bg` | `rgba(9, 105, 218, 0.08)` |
181
+ | `--split-backdrop-bg` | `rgba(0, 0, 0, 0.32)` |
182
+ | `--split-radius` | `6px` |
183
+ | `--split-tab-height` | `36px` |
184
+ | `--split-tab-max-width` | `220px` |
185
+ | `--split-font` | `inherit` |
186
+ | `--split-body-z-index` | `1040` |
187
+ | `--split-expanded-z-index` | `1050` |
188
+ | `--split-drop-zone-z-index` | `1060` |
189
+ | `--split-drag-preview-z-index` | `1070` |
190
+ | `--split-shadow` | `0 8px 24px rgba(31, 35, 40, 0.18)` |
191
+
192
+ O tamanho de cada container do body vem da opção `size` (padrão `bodySize: '420px'` no config).
193
+
194
+ ## Textos e i18n
195
+
196
+ ```ts
197
+ provideSplitWindows({
198
+ labels: {
199
+ defaultTitle: 'New tab',
200
+ emptyContainer: 'No open tabs',
201
+ },
202
+ });
203
+ ```
204
+
205
+ | Chave de `labels` | Padrão | Onde aparece |
206
+ | ----------------- | ------------------------ | ------------------------------ |
207
+ | `defaultTitle` | `'Nova aba'` | Título de `open()` sem `title` |
208
+ | `emptyContainer` | `'Nenhuma aba aberta'` | Área de conteúdo vazia |
209
+ | `closeTab` | `'Fechar aba'` | Rótulo acessível do X da aba |
210
+ | `closeAll` | `'Fechar todas as abas'` | Botão de fechar tudo |
211
+ | `expand` | `'Tela cheia'` | Botão de tela cheia |
212
+ | `restore` | `'Restaurar tamanho'` | Botão de restaurar |
213
+ | `tabList` | `'Abas'` | Rótulo da `tablist` |
214
+
215
+ Outras chaves do config: `activate` (`true`), `closable` (`true`), `closedDropZone` (`{ width: 220, height: 120 }`) e `bodySize` (`'420px'`).
216
+
217
+ ## Teclado
218
+
219
+ A barra segue o padrão WAI-ARIA de abas, com ativação automática (roles `tablist`, `tab` e `tabpanel`).
220
+
221
+ | Tecla (com foco numa aba) | Ação |
222
+ | ------------------------------------------ | ---------------------------------------------------------------------- |
223
+ | `←` / `→` | Ativa a aba anterior / seguinte (circular) |
224
+ | `Home` / `End` | Ativa a primeira / última aba |
225
+ | `Enter` / `Espaço` | Ativa a aba |
226
+ | `Delete` | Fecha a aba (se `closable`), passando pelo `canClose` |
227
+ | `Ctrl+Shift+←` / `Ctrl+Shift+→` | Move a aba uma posição na barra |
228
+ | `Esc` (foco dentro do container expandido) | Restaura o tamanho (desligue com `expand: { restoreOnEscape: false }`) |
229
+
230
+ Mover uma aba para outro container pelo teclado ainda não é suportado; use `ref.moveTo()`.
231
+
232
+ ## SSR
233
+
234
+ O adaptador roda no servidor sem erro: `window`, `document`, `ResizeObserver` e `moveBefore()` só são usados no navegador. No servidor a engine não monta shells, não cria componentes de aba e não mede nada.
235
+
236
+ ## Limitação conhecida: mover fora do Chromium
237
+
238
+ Mover uma aba (arraste ou `moveTo()`) usa `Element.moveBefore()` quando o navegador o suporta (Chrome 133+), o que preserva o estado do DOM. Nos demais (Firefox, Safari), o fallback é `appendChild`: **iframes recarregam, vídeos reiniciam e o foco se perde** quando a aba muda de container. O componente Angular em si não é recriado (sem `ngOnDestroy`), então o estado do componente é mantido.
239
+
240
+ ## Guias
241
+
242
+ Veja [docs/guides](../../docs/guides/README.md) e o app de demonstração (`npm start` na raiz).