masonry-blade 0.0.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.
package/LICENSE.txt ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,435 @@
1
+ # masonry-blade
2
+
3
+ Algo-oriented lib for create masonry grid with ZERO😭😱 dependencies
4
+
5
+ > Only images are supported for now.
6
+
7
+ <div align="center">
8
+ <img width="300" src="./.github/logo.png" alt="masonry-blad logo">
9
+ <h3 align="center">masonry-blade</h3>
10
+ </div>
11
+
12
+ ![GitHub License](https://img.shields.io/github/license/steelWinds/masonry-blade)
13
+ ![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/masonry-blade)
14
+ ![NPM Version](https://img.shields.io/npm/v/masonry-blade)
15
+
16
+ ## Quick start
17
+
18
+ `MasonryMatrix` helps you build and rebuild a masonry layout incrementally.
19
+ It keeps the original input items internally, so you can append new items over time and fully recreate the matrix when the container width or column count changes.
20
+
21
+ ### Import
22
+
23
+ ```ts
24
+ import { MasonryMatrix } from 'masonry-blade';
25
+ ```
26
+
27
+ ### What the class does
28
+
29
+ `MasonryMatrix` manages two things for you:
30
+
31
+ - the current computed masonry state
32
+ - the full list of raw input items that were previously appended
33
+
34
+ This allows two common workflows:
35
+
36
+ 1. **Append mode**: add new items to the existing matrix with `appendItems()`
37
+ 2. **Rebuild mode**: fully recompute the matrix from all previously appended items with `recreateMatrix()`
38
+
39
+ ### Constructor
40
+
41
+ ```ts
42
+ const matrix = new MasonryMatrix(rootWidth, count);
43
+ ```
44
+
45
+ #### Parameters
46
+
47
+ - `rootWidth: number` — the current container width in pixels
48
+ - `count?: number` — the number of columns; defaults to `1`
49
+
50
+ #### Example
51
+
52
+ ```ts
53
+ const matrix = new MasonryMatrix(1200, 4);
54
+ ```
55
+
56
+ This creates an internal masonry state for a `1200px` wide container with `4` columns.
57
+
58
+ ### Input item type
59
+
60
+ Your input items must match this shape:
61
+
62
+ ```ts
63
+ type ImageItem = {
64
+ id: string;
65
+ src: string;
66
+ width: number;
67
+ height: number;
68
+ };
69
+ ```
70
+
71
+ - `id` should be stable and unique for each item
72
+ - `src` is copied into the computed result
73
+ - `width` and `height` are the original item dimensions
74
+ - items with non-positive `width` or `height` are ignored by the layout engine
75
+
76
+ ### Output item type
77
+
78
+ Both `appendItems()` and `recreateMatrix()` return computed masonry columns:
79
+
80
+ ```ts
81
+ type MasonryItem = {
82
+ id: string;
83
+ src: string;
84
+ width: number;
85
+ height: number;
86
+ };
87
+ ```
88
+
89
+ The returned `width` and `height` are **computed layout dimensions**, not the original source dimensions:
90
+
91
+ - `width` is the target column width
92
+ - `height` is the scaled height for that column width
93
+
94
+ ### Important note about returned values
95
+
96
+ Both public methods return:
97
+
98
+ ```ts
99
+ Promise<readonly MasonryItem[][]>;
100
+ ```
101
+
102
+ That means:
103
+
104
+ - the result is an array of columns
105
+ - each column is an array of computed masonry items
106
+ - the outer result should be treated as **read-only**
107
+ - the returned columns are backed by the internal matrix state
108
+
109
+ You should **not mutate** the returned arrays.
110
+ If you need to transform them for rendering, create a copy first.
111
+
112
+ Example:
113
+
114
+ ```ts
115
+ const columns = await matrix.appendItems(items);
116
+
117
+ const safeColumns = columns.map((column) => [...column]);
118
+ ```
119
+
120
+ ### `appendItems()`
121
+
122
+ Use `appendItems()` when you want to add new items to the existing matrix.
123
+
124
+ ```ts
125
+ const columns = await matrix.appendItems(items);
126
+ ```
127
+
128
+ #### Parameters
129
+
130
+ - `items: readonly ImageItem[]` — the batch of new items to append
131
+
132
+ #### Returns
133
+
134
+ - `Promise<readonly MasonryItem[][]>` — the updated computed matrix columns
135
+
136
+ #### Behavior
137
+
138
+ - appends only the provided batch to the current matrix
139
+ - stores the raw items internally for future rebuilds
140
+ - reuses the current matrix state instead of rebuilding everything from scratch
141
+ - may use a worker internally when available
142
+ - falls back to synchronous calculation when a worker is not available
143
+
144
+ #### Example
145
+
146
+ ```ts
147
+ const nextItems: ImageItem[] = [
148
+ {
149
+ id: 'img-1',
150
+ src: '/images/1.jpg',
151
+ width: 1600,
152
+ height: 900,
153
+ },
154
+ {
155
+ id: 'img-2',
156
+ src: '/images/2.jpg',
157
+ width: 1200,
158
+ height: 1800,
159
+ },
160
+ ];
161
+
162
+ const columns = await matrix.appendItems(nextItems);
163
+ ```
164
+
165
+ ### `recreateMatrix()`
166
+
167
+ Use `recreateMatrix()` when the container width or column count changes and the whole matrix must be recalculated.
168
+
169
+ ```ts
170
+ const columns = await matrix.recreateMatrix(rootWidth, count);
171
+ ```
172
+
173
+ #### Parameters
174
+
175
+ - `rootWidth: number` — the new container width in pixels
176
+ - `count?: number` — the new number of columns
177
+
178
+ #### Returns
179
+
180
+ - `Promise<readonly MasonryItem[][]>` — the fully rebuilt computed matrix columns
181
+
182
+ #### Behavior
183
+
184
+ - creates a brand new internal masonry state
185
+ - replays **all previously appended raw items** into the new state
186
+ - is the correct method to call after resize or responsive breakpoint changes
187
+ - does **not** require you to pass the original items again
188
+
189
+ #### Example
190
+
191
+ ```ts
192
+ const columns = await matrix.recreateMatrix(1440, 5);
193
+ ```
194
+
195
+ ### `terminateWorker()`
196
+
197
+ ```ts
198
+ matrix.terminateWorker();
199
+ ```
200
+
201
+ Use this method if you want to explicitly terminate the internal worker.
202
+
203
+ #### Behavior
204
+
205
+ - terminates the current worker if it exists
206
+ - rejects any pending worker-backed operation
207
+ - clears the internal worker reference
208
+ - future calls to `appendItems()` or `recreateMatrix()` may create a new worker again
209
+
210
+ This is usually useful during cleanup, for example when a view or component is being destroyed.
211
+
212
+ ### Full example
213
+
214
+ ```ts
215
+ import { MasonryMatrix } from 'masonry-blade';
216
+
217
+ type ImageItem = {
218
+ id: string;
219
+ src: string;
220
+ width: number;
221
+ height: number;
222
+ };
223
+
224
+ const items: ImageItem[] = [
225
+ { id: '1', src: '/img/1.jpg', width: 1600, height: 900 },
226
+ { id: '2', src: '/img/2.jpg', width: 1200, height: 1600 },
227
+ { id: '3', src: '/img/3.jpg', width: 800, height: 1200 },
228
+ { id: '4', src: '/img/4.jpg', width: 1920, height: 1080 },
229
+ ];
230
+
231
+ function getColumnCount(width: number): number {
232
+ if (width >= 1440) return 5;
233
+ if (width >= 1024) return 4;
234
+ if (width >= 768) return 3;
235
+ if (width >= 480) return 2;
236
+ return 1;
237
+ }
238
+
239
+ async function main(): Promise<void> {
240
+ const rootWidth = 1200;
241
+ const count = getColumnCount(rootWidth);
242
+
243
+ const matrix = new MasonryMatrix(rootWidth, count);
244
+
245
+ const initialColumns = await matrix.appendItems(items);
246
+
247
+ console.log('Initial columns:', initialColumns);
248
+
249
+ const moreItems: ImageItem[] = [
250
+ { id: '5', src: '/img/5.jpg', width: 1000, height: 1500 },
251
+ { id: '6', src: '/img/6.jpg', width: 1400, height: 900 },
252
+ ];
253
+
254
+ const updatedColumns = await matrix.appendItems(moreItems);
255
+
256
+ console.log('After append:', updatedColumns);
257
+
258
+ const resizedColumns = await matrix.recreateMatrix(
259
+ 1440,
260
+ getColumnCount(1440),
261
+ );
262
+
263
+ console.log('After recreate:', resizedColumns);
264
+
265
+ matrix.terminateWorker();
266
+ }
267
+
268
+ void main();
269
+ ```
270
+
271
+ ### Responsive example with `window.resize`
272
+
273
+ The most common responsive pattern is:
274
+
275
+ 1. create the matrix once
276
+ 2. append your initial data
277
+ 3. on resize, recompute `rootWidth` and `count`
278
+ 4. call `recreateMatrix()`
279
+ 5. re-render using the returned columns
280
+
281
+ ```ts
282
+ import { MasonryMatrix } from 'masonry-blade';
283
+
284
+ type ImageItem = {
285
+ id: string;
286
+ src: string;
287
+ width: number;
288
+ height: number;
289
+ };
290
+
291
+ const container = document.getElementById('gallery');
292
+
293
+ if (container == null) {
294
+ throw new Error('Missing #gallery container');
295
+ }
296
+
297
+ const items: ImageItem[] = [
298
+ { id: '1', src: '/img/1.jpg', width: 1600, height: 900 },
299
+ { id: '2', src: '/img/2.jpg', width: 1200, height: 1600 },
300
+ { id: '3', src: '/img/3.jpg', width: 800, height: 1200 },
301
+ { id: '4', src: '/img/4.jpg', width: 1920, height: 1080 },
302
+ ];
303
+
304
+ function getColumnCount(width: number): number {
305
+ if (width >= 1024) return 4;
306
+
307
+ return 2;
308
+ }
309
+
310
+ function render(
311
+ columns: readonly (readonly {
312
+ id: string;
313
+ src: string;
314
+ width: number;
315
+ height: number;
316
+ })[][],
317
+ ): void {
318
+ container.innerHTML = '';
319
+
320
+ for (const column of columns) {
321
+ const columnEl = document.createElement('div');
322
+ columnEl.className = 'masonry-column';
323
+
324
+ for (const item of column) {
325
+ const img = document.createElement('img');
326
+ img.src = item.src;
327
+ img.width = item.width;
328
+ img.height = item.height;
329
+ img.alt = item.id;
330
+
331
+ columnEl.appendChild(img);
332
+ }
333
+
334
+ container.appendChild(columnEl);
335
+ }
336
+ }
337
+
338
+ let currentWidth = container.clientWidth;
339
+ let currentCount = getColumnCount(currentWidth);
340
+ let resizeFrame = 0;
341
+
342
+ const matrix = new MasonryMatrix(currentWidth, currentCount);
343
+
344
+ async function init(): Promise<void> {
345
+ const columns = await matrix.appendItems(items);
346
+ render(columns);
347
+ }
348
+
349
+ async function handleResize(): Promise<void> {
350
+ const nextWidth = container.clientWidth;
351
+ const nextCount = getColumnCount(nextWidth);
352
+
353
+ if (nextWidth === currentWidth && nextCount === currentCount) {
354
+ return;
355
+ }
356
+
357
+ currentWidth = nextWidth;
358
+ currentCount = nextCount;
359
+
360
+ const columns = await matrix.recreateMatrix(currentWidth, currentCount);
361
+ render(columns);
362
+ }
363
+
364
+ window.addEventListener('resize', () => {
365
+ cancelAnimationFrame(resizeFrame);
366
+
367
+ resizeFrame = requestAnimationFrame(() => {
368
+ void handleResize();
369
+ });
370
+ });
371
+
372
+ void init();
373
+
374
+ window.addEventListener('beforeunload', () => {
375
+ matrix.terminateWorker();
376
+ });
377
+ ```
378
+
379
+ ### Useful notes
380
+
381
+ - Use `appendItems()` for incremental updates.
382
+ - Use `recreateMatrix()` after width or column count changes.
383
+ - Do not mutate the returned columns.
384
+ - Do not call `appendItems()` and `recreateMatrix()` concurrently.
385
+ - Serialize access in your application code.
386
+ - Call `terminateWorker()` during cleanup when needed.
387
+
388
+ ### Concurrency note
389
+
390
+ Concurrent calls are not supported.
391
+ The caller must serialize access to:
392
+
393
+ - `appendItems()`
394
+ - `recreateMatrix()`
395
+
396
+ For example, do not call `appendItems()` while a previous `recreateMatrix()` call is still pending.
397
+
398
+ ## Development
399
+
400
+ ### Environment variables
401
+
402
+ See the `docs/` directory for example `.env.*` files. **Environment variable files should be located in the project root directory.**
403
+
404
+ ### Setup for Development
405
+
406
+ ```bash
407
+ git clone https://github.com/steelWinds/masonry-blade
408
+
409
+ cd masonry-blade
410
+
411
+ # Install dependencies
412
+ pnpm i
413
+
414
+ # Run tests
415
+ pnpm test:run
416
+ ```
417
+
418
+ ### Benchmark
419
+
420
+ ```bash
421
+ pnpm benchmark
422
+ ```
423
+
424
+ Latest benchmark results: [benchmark/benchmark-results.md](benchmark/benchmark-results.md)
425
+
426
+ ## License
427
+
428
+ This project is licensed under the MPL 2.0 License.
429
+
430
+ ## Links
431
+
432
+ - Author: [@steelWinds](https://github.com/steelWinds)
433
+ - Issues: [New issue](https://github.com/steelWinds/masonry-blade/issues)
434
+ - Telegram: @plutograde
435
+ - Email: [Send me an email](mailto:kirillsurov0@gmail.com)
@@ -0,0 +1,36 @@
1
+ //#region src/utils/MasonryMatrix/lib/masonryEngine/appendToMatrix.ts
2
+ const appendToMatrix = (state, items) => {
3
+ const { count, width, heights, order, columns } = state;
4
+ if (count <= 0 || items.length === 0) return state;
5
+ for (let i = 0, len = items.length; i < len; i++) {
6
+ const item = items[i];
7
+ if (item.width <= 0 || item.height <= 0) continue;
8
+ const [shortest] = order;
9
+ const height = Math.floor(item.height * width / item.width);
10
+ columns[shortest].push({
11
+ height,
12
+ id: item.id,
13
+ src: item.src,
14
+ width
15
+ });
16
+ const newColumnHeight = heights[shortest] + height;
17
+ heights[shortest] = newColumnHeight;
18
+ let pos = 1;
19
+ while (pos < count) {
20
+ const next = order[pos];
21
+ if (heights[next] > newColumnHeight) break;
22
+ order[pos - 1] = next;
23
+ pos++;
24
+ }
25
+ order[pos - 1] = shortest;
26
+ }
27
+ return state;
28
+ };
29
+ //#endregion
30
+ //#region src/utils/MasonryMatrix/lib/masonryEngine/appendToMatrix.worker.ts
31
+ self.onmessage = (event) => {
32
+ const { state, batchItems } = event.data;
33
+ const result = appendToMatrix(state, batchItems);
34
+ self.postMessage(result);
35
+ };
36
+ //#endregion
@@ -0,0 +1 @@
1
+ const e=(e,t)=>{let{count:n,width:r,heights:i,order:a,columns:o}=e;if(n<=0||t.length===0)return e;for(let e=0,s=t.length;e<s;e++){let s=t[e];if(s.width<=0||s.height<=0)continue;let[c]=a,l=Math.floor(s.height*r/s.width);o[c].push({height:l,id:s.id,src:s.src,width:r});let u=i[c]+l;i[c]=u;let d=1;for(;d<n;){let e=a[d];if(i[e]>u)break;a[d-1]=e,d++}a[d-1]=c}return e},t=(e,t=1)=>{let n=new Int32Array(t),r=new Int16Array(t),i=Array.from({length:t},()=>[]);for(let e=0;e<t;e++)r[e]=e;return{columns:i,count:t,heights:n,order:r,width:t===0?0:Math.floor(e/t)}};function n(e){return new Worker(new URL(`appendToMatrix.worker.js`,import.meta.url),{type:`module`,name:e?.name})}var r=class{_worker;_workerTerminatedSignal;_state;_rawItems;constructor(e,n){this._state=t(e,n),this._rawItems=[]}async _updateState(t,n){try{return this._worker??this._createWorker(),this._worker==null?e(t,n):await new Promise((e,r)=>{this._workerTerminatedSignal=r,this._worker.onmessage=t=>{this._workerTerminatedSignal=void 0,e(t.data)},this._worker.onmessageerror=()=>{this._workerTerminatedSignal=void 0,r(Error(`[MasonryMatrix] Error receiving message from worker`))},this._worker.onerror=e=>{this._workerTerminatedSignal=void 0,r(Error(`[MasonryMatrix] Error while worker: ${e.message}`))},this._worker.postMessage({batchItems:n,state:t})})}catch(e){throw console.error(`[MasonryMatrix] Error while update internal state: ${e}`),e}}_appendToRawItems(e){let t=this._rawItems.length,n=e.length;this._rawItems.length=t+n;for(let r=0;r<n;r++)this._rawItems[t+r]=e[r]}_createWorker(){globalThis&&`Worker`in globalThis&&(this._worker=new n)}terminateWorker(){this._workerTerminatedSignal?.(Error(`[MasonryMatrix] Worker terminated`)),this._worker?.terminate(),this._workerTerminatedSignal=void 0,this._worker=void 0}async appendItems(e){try{return this._state=await this._updateState(this._state,e),this._appendToRawItems(e),this._state.columns}catch(e){throw console.error(`[MasonryMatrix] Error while append items to matrix: ${e}`),e}}async recreateMatrix(e,n){try{return this._state=t(e,n),this._state=await this._updateState(this._state,this._rawItems),this._state.columns}catch(e){throw console.error(`[MasonryMatrix] Error while recreate matrix: ${e}`),e}}};export{r as MasonryMatrix};
package/package.json ADDED
@@ -0,0 +1,79 @@
1
+ {
2
+ "name": "masonry-blade",
3
+ "version": "0.0.1",
4
+ "private": false,
5
+ "description": "Algo-oriented lib for create masonry grid",
6
+ "keywords": [
7
+ "generate",
8
+ "lib",
9
+ "masonry"
10
+ ],
11
+ "homepage": "https://github.com/steelWinds/masonry-blade",
12
+ "bugs": {
13
+ "url": "https://github.com/steelWinds/masonry-blade/issues",
14
+ "email": "kirillsurov0@gmail.com"
15
+ },
16
+ "license": "MPL-2.0",
17
+ "author": "steelWinds",
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "https://github.com/steelWinds/masonry-blade"
21
+ },
22
+ "files": [
23
+ "build",
24
+ "README.md",
25
+ "LICENSE"
26
+ ],
27
+ "os": [
28
+ "darwin",
29
+ "linux",
30
+ "win32"
31
+ ],
32
+ "type": "module",
33
+ "main": "./build/masonry-blade.mjs",
34
+ "scripts": {
35
+ "build": "genversion lib/version.js --esm --strict && tsdown --minify --log-level error",
36
+ "build:watch": "genversion lib/version.js --esm --strict && tsdown --sourcemap --watch",
37
+ "benchmark": "tsdown --minify --log-level error && cross-env NODE_OPTIONS='--expose-gc --max-old-space-size=8192' tsx benchmark/matrix.benchmark.ts",
38
+ "test": "vitest",
39
+ "test:run": "vitest run --testTimeout 0",
40
+ "test:coverage": "vitest run --coverage",
41
+ "lint": "oxlint --type-aware",
42
+ "lint:fix": "oxlint --fix",
43
+ "nano-staged": "nano-staged",
44
+ "fmt": "oxfmt",
45
+ "fmt:check": "oxfmt --check",
46
+ "prepare": "husky"
47
+ },
48
+ "devDependencies": {
49
+ "@faker-js/faker": "^10.2.0",
50
+ "@types/node": "^25.3.5",
51
+ "@vitest/coverage-v8": "^4.0.17",
52
+ "cross-env": "^10.1.0",
53
+ "genversion": "^3.2.0",
54
+ "husky": "^9.1.7",
55
+ "nano-staged": "^0.9.0",
56
+ "oxfmt": "^0.35.0",
57
+ "oxlint": "^1.42.0",
58
+ "oxlint-tsgolint": "^0.16.0",
59
+ "tinybench": "^6.0.0",
60
+ "tsdown": "0.20.3",
61
+ "tsdown-plugin-worker": "^0.1.9",
62
+ "tsx": "^4.21.0",
63
+ "typescript": "~5.9.3",
64
+ "vitest": "^4.0.17"
65
+ },
66
+ "overrides": {
67
+ "tsdown": "0.20.3"
68
+ },
69
+ "nano-staged": {
70
+ "*": "oxfmt --no-error-on-unmatched-pattern",
71
+ "*.{js,jsx,ts,tsx,mjs,cjs}": [
72
+ "pnpm run lint",
73
+ "pnpm run test:run --passWithNoTests"
74
+ ]
75
+ },
76
+ "engines": {
77
+ "node": ">=18.0.0"
78
+ }
79
+ }