https://github.com/fxdave/react-konva-anchors
A helping package for positioning, and sizing react -konva objects. HTML and CSS provide an easy solution for this, but for canvas, it is more painful. This library aims to ease your work with react-konva.
https://github.com/fxdave/react-konva-anchors
anchor canvas konva positioning react sizing
Last synced: 6 months ago
JSON representation
A helping package for positioning, and sizing react -konva objects. HTML and CSS provide an easy solution for this, but for canvas, it is more painful. This library aims to ease your work with react-konva.
- Host: GitHub
- URL: https://github.com/fxdave/react-konva-anchors
- Owner: fxdave
- License: mit
- Created: 2019-02-01T00:20:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T00:40:04.000Z (almost 3 years ago)
- Last Synced: 2025-03-25T03:49:14.170Z (7 months ago)
- Topics: anchor, canvas, konva, positioning, react, sizing
- Language: JavaScript
- Size: 134 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-konva-anchros
A helping package for positioning, and sizing react-konva objects. HTML and CSS provide an easy solution for this, but for canvas, it is more painful. This library aims to ease your work with react-konva.
## Installation
`npm i react-konva-anchors`
## Example
```javascript
this.bg.current}
change={(x, y) => this.setState({ bgPos: { x, y } })} />
this.text.current}
elementOrigin={{x:0,y:0}}
elementDesiredOrigin={{x:0.5, y:0.5}}
reference={() => this.bg.current}
referenceOrigin={{x:0,y:0}}
referenceDesiredOrigin={{x:0.5, y:0.5}}
change={(x, y) => this.setState({ textPos: { x, y } })} />
this.deleteButton.current}
elementOrigin={{x:0.5,y:0.5}}
elementDesiredOrigin={{x:0.5, y:0.5}}
reference={() => this.bg.current}
referenceOrigin={{x:0,y:0}}
referenceDesiredOrigin={{x:1, y:0}}
change={(x, y) => this.setState({ deleteButtonPos: { x, y } })} />
this.addButton.current}
elementOrigin={{x:0.5,y:0.5}}
elementDesiredOrigin={{x:0.5, y:0.5}}
reference={() => this.bg.current}
referenceOrigin={{x:0,y:0}}
referenceDesiredOrigin={{x:1, y:0}}
shift={{x:-25, y:0}}
change={(x, y) => this.setState({ addButtonPos: { x, y } })} />
this.text.current}
element={() => this.bg.current}
padding={25}
change={width => this.setState({ bgWidth: width })} />
```
## Usage
### CenterAnchor
```javascript
this.A_KONVA_ELEMENT_REGERENCE.current}
change={(x, y) => this.setState({ A_KONVA_ELEMENT_POSITION: { x, y } })} />
```
There are some konva objects where the origin is not at the center of the object for e.g Rect, Text.
If you want to center it, you can use CenterAnchor. This will query the size of the shape and returns a new position for that. (Basically x=width / 2 , y=height / 2). So ensure that you won't move this element, If you want to move, drop into a group and move the group instead.
Use case: If you want to place a rectangle where you click, But you won't know the size of the rectangle, and you want to place in the middle of the pointer. Then this anchor will be a perfect choice.
See: [konvajs/konva#487].
### WidthAnchor
```javascript
this.KONVA_ELEMENT_REFERENCE_TO_WATCH.current}
element={() => this.KONVA_ELEMENT_REFERENCE_TO_CHANGE.current}
padding={25}
change={width => this.setState({ KONVA_ELEMENT_WIDTH: width })} />
```
Sets the width of an element based on another element's width.
Use case: If you have a text, and you want to make a rectangle background for that, this will fit perfectly.
### PositionAnchor
```javascript
this.KONVA_ELEMENT_REFERENCE_TO_MOVE.current}
elementOrigin={{x:0.5,y:0.5}} // the element is centered originally
elementDesiredOrigin={{x:0.5, y:0.5}} // we don't want to change it so we keep it centered
reference={() => this.KONVA_ELEMENT_REFERENCE_TO_WATCH.current}
referenceOrigin={{x:0,y:0}} // the reference element starts from the left top corner
referenceDesiredOrigin={{x:1, y:0}} // we want to move the element to the top right corner
// basically it will just move the element origin to the desired reference origin
shift={{x:-25, y:0}} // then we shift it by -25 on x
change={(x, y) => this.setState({ KONVA_ELEMENT_POSITION: { x, y } })} />
```
The elementOrigin is the original origin usually {x:0,y:0} or if it is centered then {x:0.5,y:0.5},
but you can set it to anywhere in your shape like: top right corner: {x:1,y:0}.
The elementDesiredOrigin is the origin where you want to grab the element.
The referenceOrigin is the same as elementOrigin but for the reference element.
The referenceDesiredOrigin is the origin point where you want to place the element.
The shift is a final transformation.
With origins you can reach percentage based positioning.
With shifts you can move by pixels.
Use case: For example, you can use it to pose a button to the top right corner of a rectangle.
### CustomAnchor
```javascript
this.KONVA_ELEMENT_REFERENCE_TO_WATCH.current }
element={ () => this.KONVA_ELEMENT_REFERENCE_TO_CHANGE.current }
result={ (ref) => ({ x: ref.width(), y:0 }) }
isUpdateNeeded={ (el, res) => el.x() !== res.x || el.y() !== res.y }
change={ (res) => { this.setState({ KONVA_ELEMENT_PROPERTY: res }) } }
/>
```
The result is a function which returns a computed result from the reference object for example a position.
The isUpdateNeeded is a function that receives the element and the result and returns a boolean. If it is true the change function will be called. Hint: use Math.round when you compare numbers.
Use case: If you can't find right solution from the anchors above, you can use this.
## Contributing
If you want to help me, form an issue, or send pull requests.