@khesira/textflow 1.0.3 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +13 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -95,18 +95,19 @@ const settings: Settings = {
95
95
 
96
96
  ## Configuration (Settings)
97
97
 
98
- | Property | Type | Default Value | Description |
99
- | :--- | :--- | :--- | :--- |
100
- | `width` | `string` | `"100%"` | CSS width of the slider component (e.g., `"100%"`, `"400px"`). |
101
- | `height` | `string` | `"150px"` | CSS height of the slider component. |
102
- | `font` | `string` | `"sans-serif"` | Font family used inside the Canvas rendering context. |
103
- | `color` | `string` | `"#ffffff"` | Text color (accepts hex, rgb, rgba, or CSS color names). |
104
- | `background` | `string` | `"transparent"` | Background color of the canvas container. |
105
- | `maxTexts` | `number` | `10` | Maximum number of text elements allowed on screen simultaneously. |
106
- | `maxAcceleration` | `number` | `3` | Maximum velocity cap for the text particles. |
107
- | `marginTop` | `number` | `0` | Top boundary padding (in pixels) to restrict the spawn area. |
108
- | `marginBottom` | `number` | `0` | Bottom boundary padding (in pixels) to restrict the spawn area. |
109
- | `debug` | `boolean` | `false` | Enables red AABB bounding boxes and highlights the canvas clear zones. |
98
+ | Property | Type | Default Value | Description |
99
+ |:------------------|:-----------|:------------------|:-----------------------------------------------------------------------|
100
+ | `width` | `string` | `"100%"` | CSS width of the slider component (e.g., `"100%"`, `"400px"`). |
101
+ | `height` | `string` | `"150px"` | CSS height of the slider component. |
102
+ | `font` | `string` | `"sans-serif"` | Font family used inside the Canvas rendering context. |
103
+ | `color` | `string` | `"#ffffff"` | Text color (accepts hex, rgb, rgba, or CSS color names). |
104
+ | `background` | `string` | `"transparent"` | Background color of the canvas container. |
105
+ | `maxTexts` | `number` | `10` | Maximum number of text elements allowed on screen simultaneously. |
106
+ | `maxAcceleration` | `number` | `3` | Maximum velocity cap for the text particles. |
107
+ | `headings` | `string[]` | `['EAST','WEST']` | Flow directions of the texts picked randomly on each page load. |
108
+ | `marginTop` | `number` | `0` | Top boundary padding (in pixels) to restrict the spawn area. |
109
+ | `marginBottom` | `number` | `0` | Bottom boundary padding (in pixels) to restrict the spawn area. |
110
+ | `debug` | `boolean` | `false` | Enables red AABB bounding boxes and highlights the canvas clear zones. |
110
111
 
111
112
  ## Architecture
112
113
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@khesira/textflow",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "license": "MIT",
5
5
  "author": "Mika Jünger",
6
6
  "description": "A framework agnostic canvas physics text slider",