Skip to content

Commit 7e8f746

Browse files
committed
add input properties
1 parent d2bb19c commit 7e8f746

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ myBox.getPath();
6565

6666
3. **Create an eBox**
6767

68-
This creates a rectangle, with a set of controls for modifying it.
68+
You then call the `.createBox()` function, passing it an object containing the properties for box.
6969

7070
```javascript
7171
const myBox = eBox.createBox({
@@ -76,6 +76,26 @@ myBox.getPath();
7676
});
7777
```
7878

79+
<details><summary><strong>Box Object Properties</strong></summary>
80+
<br>
81+
82+
- **`size`:** The size of the box, in pixels
83+
- Type: `array`
84+
- Required: `true`
85+
- **`position`:** The position of the box in the composition
86+
- Type: `array`
87+
- Required: `true`
88+
- **`anchor`:** The anchor point that will be at the given `position`
89+
- Type: `string`
90+
- Options: `topLeft, topRight, bottomLeft, bottomRight, center`
91+
- Required: `true`
92+
- **`isClosed`:** Whether the path is closed
93+
- Type: `boolean`
94+
- Required: `false`
95+
- Default: `true`
96+
</details>
97+
<br>
98+
7999
4. **Set the scale**
80100

81101
> This step is optional, you can call `myBox.getPath()` without applying any scaling
@@ -86,8 +106,19 @@ myBox.getPath();
86106
myBox.setScale(scale, anchorPoint);
87107
```
88108

89-
- scale: `[0...100, 0...100]`
90-
- anchorPoint: ``
109+
<details><summary><strong>Set Scale Parameters</strong></summary>
110+
<br>
111+
112+
- **`scale`:** Scale of the box
113+
- Type: `array`
114+
- Range: `[0..100, 0..100]`
115+
- Required: `true`
116+
- **`anchor`:** The anchor point that will be at the given `position`
117+
- Type: `string`
118+
- Options: `topLeft, topRight, bottomLeft, bottomRight, center`
119+
- Required: `true`
120+
</details>
121+
<br>
91122

92123
5. **Show the box**
93124

0 commit comments

Comments
 (0)