Skip to content

Commit 0bda0c0

Browse files
committed
Rename regular-layout-resize-before to regular-layout-before-resize for consistency
1 parent 1b074b9 commit 0bda0c0

5 files changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ localStorage.setItem("layout", JSON.stringify(state));
9494
layout.restore(JSON.parse(localStorage.getItem("layout")));
9595
```
9696

97-
`restore()` dispatches a cancelable `regular-layout-resize-before` event before
97+
`restore()` dispatches a cancelable `regular-layout-before-resize` event before
9898
applying the new state. Call `preventDefault()` to suspend the update, then
9999
`layout.resumeResize()` when ready:
100100

101101
```javascript
102-
layout.addEventListener("regular-layout-resize-before", (event) => {
102+
layout.addEventListener("regular-layout-before-resize", (event) => {
103103
event.preventDefault();
104104
// ... prepare for resize ...
105105
layout.resumeResize();
@@ -152,7 +152,7 @@ complete theme for `<regular-layout>` and `regular-layout-frame>`.
152152

153153
| Event | Detail | Cancelable | Description |
154154
|-------|--------|------------|-------------|
155-
| `regular-layout-resize-before` | `{ calculatePresizePaths() }` | Yes | Fired before any layout change. Cancel to suspend until `resumeResize()`. |
155+
| `regular-layout-before-resize` | `{ calculatePresizePaths() }` | Yes | Fired before any layout change. Cancel to suspend until `resumeResize()`. |
156156
| `regular-layout-update` | `Layout` | No | Fired after layout state is updated. |
157157

158158
```javascript

src/core/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export interface LayoutPath {
9696
}
9797

9898
/**
99-
* The detail payload of the `regular-layout-resize-before` event.
99+
* The detail payload of the `regular-layout-before-resize` event.
100100
*/
101101
export interface PresizeDetail {
102102
calculatePresizePaths(): Record<string, LayoutPath>;

src/extensions.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ declare global {
6060
): void;
6161

6262
addEventListener(
63-
name: "regular-layout-resize-before",
63+
name: "regular-layout-before-resize",
6464
cb: (e: RegularLayoutPresizeEvent) => void,
6565
options?: { signal: AbortSignal },
6666
): void;
@@ -76,7 +76,7 @@ declare global {
7676
): void;
7777

7878
removeEventListener(
79-
name: "regular-layout-resize-before",
79+
name: "regular-layout-before-resize",
8080
cb: (e: RegularLayoutPresizeEvent) => void,
8181
): void;
8282
}

src/regular-layout.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export class RegularLayout extends HTMLElement {
128128
this._stylesheet = new CSSStyleSheet();
129129
this._cursor_stylesheet = new CSSStyleSheet();
130130
this._cursor_override = false;
131-
const event_name = `${this._physics.CUSTOM_EVENT_NAME_PREFIX}-resize-before`;
131+
const event_name = `${this._physics.CUSTOM_EVENT_NAME_PREFIX}-before-resize`;
132132
this._presizeQueue = new PresizeQueue(this, event_name);
133133
this._overlayController = new OverlayController(this.create_overlay_host());
134134
this._shadowRoot.adoptedStyleSheets = [
@@ -288,7 +288,7 @@ export class RegularLayout extends HTMLElement {
288288

289289
/**
290290
* Restores the layout from a saved state synchronously, without
291-
* dispatching the `regular-layout-resize-before` event.
291+
* dispatching the `regular-layout-before-resize` event.
292292
*
293293
* @param layout - The layout tree to restore
294294
*/
@@ -304,7 +304,7 @@ export class RegularLayout extends HTMLElement {
304304
/**
305305
* Restores the layout from a saved state.
306306
*
307-
* Before applying, dispatches a cancelable `regular-layout-resize-before`
307+
* Before applying, dispatches a cancelable `regular-layout-before-resize`
308308
* event. If the event is cancelled via `preventDefault()`, the layout
309309
* update is suspended until {@link resumeResize} is called.
310310
*
@@ -333,7 +333,7 @@ export class RegularLayout extends HTMLElement {
333333

334334
/**
335335
* Resumes a layout update that was suspended by cancelling the
336-
* `regular-layout-resize-before` event.
336+
* `regular-layout-before-resize` event.
337337
*/
338338
resumeResize = () => {
339339
this._presizeQueue.resume();

tests/integration/resize-before.spec.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ import { expect, test } from "../helpers/coverage.ts";
1313
import { setupLayout, saveLayout, dragMouse } from "../helpers/integration.ts";
1414
import { LAYOUTS } from "../helpers/fixtures.ts";
1515

16-
test("should fire regular-layout-resize-before on restore", async ({
16+
test("should fire regular-layout-before-resize on restore", async ({
1717
page,
1818
}) => {
1919
await setupLayout(page, LAYOUTS.SINGLE_AAA);
2020
const fired = await page.evaluate(async () => {
2121
const layout = document.querySelector("regular-layout");
2222
let eventFired = false;
23-
layout?.addEventListener("regular-layout-resize-before", () => {
23+
layout?.addEventListener("regular-layout-before-resize", () => {
2424
eventFired = true;
2525
});
2626
await layout?.restore({
@@ -42,7 +42,7 @@ test("should provide calculatePresizePaths in event detail", async ({
4242
value: null,
4343
};
4444

45-
layout?.addEventListener("regular-layout-resize-before", (e) => {
45+
layout?.addEventListener("regular-layout-before-resize", (e) => {
4646
presizePaths.value = (
4747
e as CustomEvent
4848
).detail.calculatePresizePaths() as Record<string, unknown>;
@@ -80,7 +80,7 @@ test("should suspend resize when preventDefault is called", async ({
8080
await setupLayout(page, LAYOUTS.SINGLE_AAA);
8181
const result = await page.evaluate(async () => {
8282
const layout = document.querySelector("regular-layout");
83-
layout?.addEventListener("regular-layout-resize-before", (e) => {
83+
layout?.addEventListener("regular-layout-before-resize", (e) => {
8484
e.preventDefault();
8585
});
8686

@@ -113,7 +113,7 @@ test("should resume suspended resize when resumeResize is called", async ({
113113
await setupLayout(page, LAYOUTS.SINGLE_AAA);
114114
const result = await page.evaluate(async () => {
115115
const layout = document.querySelector("regular-layout");
116-
layout?.addEventListener("regular-layout-resize-before", (e) => {
116+
layout?.addEventListener("regular-layout-before-resize", (e) => {
117117
e.preventDefault();
118118
});
119119

@@ -144,7 +144,7 @@ test("should proceed immediately when event is not cancelled", async ({
144144
const tabs = await page.evaluate(async () => {
145145
const layout = document.querySelector("regular-layout");
146146
let eventCount = 0;
147-
layout?.addEventListener("regular-layout-resize-before", () => {
147+
layout?.addEventListener("regular-layout-before-resize", () => {
148148
eventCount++;
149149
});
150150
await layout?.restore({
@@ -167,7 +167,7 @@ test("should fire resize-before on drag resize", async ({ page }) => {
167167
await page.evaluate(() => {
168168
const layout = document.querySelector("regular-layout");
169169
(window as unknown as Record<string, number>).__resizeBeforeCount = 0;
170-
layout?.addEventListener("regular-layout-resize-before", () => {
170+
layout?.addEventListener("regular-layout-before-resize", () => {
171171
(window as unknown as Record<string, number>).__resizeBeforeCount++;
172172
});
173173
});
@@ -196,7 +196,7 @@ test("should queue concurrent resizes and process sequentially", async ({
196196
let callCount = 0;
197197
let cancelFirst = true;
198198

199-
layout?.addEventListener("regular-layout-resize-before", (e) => {
199+
layout?.addEventListener("regular-layout-before-resize", (e) => {
200200
callCount++;
201201
events.push(`before-${callCount}`);
202202
if (cancelFirst) {
@@ -243,7 +243,7 @@ test("should provide pre-resize panel paths for nested layout", async ({
243243
const paths = await page.evaluate(async () => {
244244
const layout = document.querySelector("regular-layout");
245245
let presizePaths: Record<string, Record<string, unknown>> | null = null;
246-
layout?.addEventListener("regular-layout-resize-before", (e) => {
246+
layout?.addEventListener("regular-layout-before-resize", (e) => {
247247
presizePaths = (e as CustomEvent).detail.calculatePresizePaths();
248248
});
249249

@@ -299,7 +299,7 @@ test("should fire resize-before on double-click equalize", async ({ page }) => {
299299
await page.evaluate(() => {
300300
const layout = document.querySelector("regular-layout");
301301
(window as unknown as Record<string, boolean>).__resizeBeforeFired = false;
302-
layout?.addEventListener("regular-layout-resize-before", () => {
302+
layout?.addEventListener("regular-layout-before-resize", () => {
303303
(window as unknown as Record<string, boolean>).__resizeBeforeFired = true;
304304
});
305305
});
@@ -326,7 +326,7 @@ test("should not fire resize-before on restoreSync", async ({ page }) => {
326326
const fired = await page.evaluate(() => {
327327
const layout = document.querySelector("regular-layout");
328328
let eventFired = false;
329-
layout?.addEventListener("regular-layout-resize-before", () => {
329+
layout?.addEventListener("regular-layout-before-resize", () => {
330330
eventFired = true;
331331
});
332332
layout?.restoreSync({

0 commit comments

Comments
 (0)