@pictogrammers/components 0.5.9 → 0.5.10

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@pictogrammers/components",
     "type": "module",
-    "version": "0.5.9",
+    "version": "0.5.10",
     "license": "MIT",
     "author": "Austin Andrews",
     "scripts": {

package/pg/inputPixelEditor/README.md

@@ -3,11 +3,11 @@
 The `pg-input-pixel-editor` component is used to edit images. Tailored for pen or mouse input the editor can be used for various image editing tasks.
 
 ```typescript
-import '@pictogrammers/components/pgInputPixelEditor';
+import '@pictogrammers/components/pg/inputPixelEditor';
 import PgInputPixelEditor, {
   InputMode,
   LayerType,
-} from '@pictogrammers/components/pgInputPixelEditor';
+} from '@pictogrammers/components/pg/inputPixelEditor';
 ```
 
 ```html
@@ -50,8 +50,10 @@ See usage for each method below.
 | `setData()` | -           | Set layer data. |
 | `setJson(json)` | -        | Set JSON file. |
 | `reset()` | -  | Reset canvas and data. |
-| `getExportCanvas()` | -  | Get new canvas of export. |
-| `await getExportPng(options, meta)` | -  | Get image. |
+| `getExport()` | -  | 2d array of pixel color indexes. Already calculated. |
+| `getExport(id)` | -  | 2d array of pixel color indexes by export size. Minimal perf. |
+| `getExportCanvas()` | -  | Get new prepopulated HTML canvas, ideal for advanced export screens. |
+| `await getExportPng(options, meta)` | -  | Get png image with optional metadata. |
 | `undo()` | -           | Undo. |
 | `hasUndo()` | -     | Has undo |
 | `hasRedo()` | -     | Has redo |
@@ -179,6 +181,11 @@ A complete JSON storage for a 10x10 image.
       [{ "color": 2, "path": "M...Z" }]
     ]
   ],
+  "grid": {
+    "vertical": [],
+    "horizontal": []
+  },
+  "exports": [],
   "history": []
 }
 ```
@@ -291,6 +298,92 @@ this.$input.addEventListener('reference', (e: any) => {
 });
 ```
 
+## Grid
+
+Grids seperate the frame into regions. The vertical and horizontal lines can be assigned a unique color often used in fonts.
+
+Grid lines on 0 or when equal or greater than to width/height are deleted. Applying a grid or resizing a frame will result in an error. Errors are handled by the consumer via the `error` event. `errorType: 'grid'`.
+
+```text
+0, 0 | 1, 0 | 2, 0
+0, 1 | 1, 1 | 2, 1
+0, 2 | 1, 2 | 2, 2
+```
+
+An example of a 9 segment grid for instance. Negative values offset from the right or bottom.
+
+> Note: When configuring exports all grid colors with `color: 0` will be visible.
+
+```json
+{
+  "grid": [{
+    "vertical": [
+      { "offset": 10, "color": 0 },
+      { "offset": -10, "color": 0 }
+    ],
+    "horizontal": [
+      { "offset": 10, "color": 0 },
+      { "offset": -10, "color": 0 }
+    ]
+  }]
+}
+```
+
+Specific grid colors are configured on the editor level and do not persist in this input component. In a font the first 5 colors are reserved for the below lines.
+
+- `1` - Ascender Line
+- `2` - Cap Line
+- `3` - Median / Mean line
+- `4` - Baseline
+- `5` - Decender Line
+
+### Repeating Grids
+
+A repeating grid is useful for tilesets and can be represented as.
+- `offset` can be optional or null when `step` is defined.
+- `limit` can be optional or null. Null repeats for as many times as it can fit.
+- Similar to regular grids an error will throw if the first line is outside the `width` or `height`.
+
+To create a repeating 20 pixel grid without an offset.
+
+```json
+{ "step": 20, "color": 0 },
+```
+
+To create a repeating 10 pixel grid with an offset `5` and limit `10`. The use case of this would be comps where a tileset does not evently sit in a viewport and needs to be centered.
+
+```json
+{ "offset": 5, "step": 10, "limit": 10, "color": 0 },
+```
+
+## Export
+
+Exports by default include the entire canvas, but can be resized to a specific pixel size or grid. The `x`, `y`, `width`, and `height` are optional.
+
+Use `getExport(id)` with a `id` value to get the data grid. This is ideal for export previews.
+
+```json
+{
+  "exports": [{
+    "id": "uuid",
+    "unit": "pixel",
+    "path": ["file.png"],
+    "x": 0,
+    "y": 0,
+    "width": null,
+    "height": null,
+  }, {
+    "id": "uuid",
+    "unit": "grid",
+    "path": ["folder", "bottomRight.png"],
+    "x": 2,
+    "y": 2,
+    "width": 1,
+    "height": 1,
+  }]
+}
+```
+
 ## History
 
 The history list contains every change made to the canvas. All feature insert an entry into history. Pens and pattern tools will group as to cut down history entries.

package/pg/inputPixelEditor/inputPixelEditor.ts

@@ -96,6 +96,16 @@ interface Export {
   height?: number
 }
 
+interface GridItem {
+  value: number
+  color: number
+}
+
+interface Grid {
+  vertical: GridItem[]
+  horizontal: GridItem[]
+}
+
 function toColor([r, g, b, a]: Color) {
   return `rgba(${r}, ${g}, ${b}, ${a})`;
 }
@@ -139,6 +149,7 @@ export default class PgInputPixelEditor extends HTMLElement {
   #selectionPixels = new Map<string, number[]>(); // 'x,y', [x, y]
   #selection: number[][] = [];
   #export: number[][] = [];
+  #grid: Grid = { vertical: [], horizontal: [] };
   #undoHistory: History[] = [];
   #redoHistory: History[] = [];
   #context: CanvasRenderingContext2D;
@@ -1518,6 +1529,10 @@ export default class PgInputPixelEditor extends HTMLElement {
     });
   }
 
+  getExport() {
+    return this.#export;
+  }
+
   getExportPath() {
     return bitmaskToPath(this.#export, { scale: 1 });
   }

package/pg/inputPixelEditor/utils/exportType.ts

@@ -0,0 +1 @@
+export type ExportType = 'pixel' | 'grid';

package/pg/inputPixelEditor/utils/inputMode.ts

@@ -6,6 +6,7 @@ export const enum InputMode {
   SelectMagicWand,
   Stamp,
   Pixel,
+  Erase,
   Line,
   Rectangle,
   RectangleOutline,

package/pg/inputText/inputText.css

@@ -14,7 +14,7 @@
   font-size: 1rem;
   outline: none;
   field-sizing: content;
-  min-width: calc(100% - 1.5rem - 2px);
+  min-width: calc(100% - 1rem - 2px);
   max-width: calc(var(--pg-input-text-max-width, 100%) - 1.5rem - 2px);
   background-color: transparent;
 }