Skip to content

Gun-Vue docs v0.25.1


Gun-Vue docs / space/useDraw / useDraw

Function: useDraw() ​

useDraw(): object

Defined in: src/space/useDraw.js:89

Returns ​

object

brush ​

brush: object

brush.arrowEnd ​

arrowEnd: boolean = false

brush.color ​

color: string

brush.mode ​

mode: string = "stylus"

brush.size ​

size: number = 10

drauu ​

drauu: Raw<Drauu>

draw ​

draw: object

draw.canClear ​

canClear: boolean = false

draw.canRedo ​

canRedo: boolean = false

draw.canUndo ​

canUndo: boolean = false

draw.clear() ​

clear: () => void

Returns ​

void

draw.colors ​

colors: string[]

draw.content ​

content: string = ""

draw.enabled ​

enabled: boolean = false

draw.ing ​

ing: boolean = false

draw.initiated ​

initiated: boolean = false

draw.mode ​

mode: string

draw.modes ​

modes: string[]

draw.pinned ​

pinned: boolean

draw.sizes ​

sizes: object

draw.sizes.go() ​

go: (i) => number

Go to a specific index

Parameters ​
i ​

number

Returns ​

number

draw.sizes.index ​

index: number

draw.sizes.next() ​

next: (n?) => number

Parameters ​
n? ​

number

Returns ​

number

draw.sizes.prev() ​

prev: (n?) => number

Parameters ​
n? ​

number

Returns ​

number

draw.sizes.state ​

state: number

loadCanvas() ​

loadCanvas: () => void

Returns ​

void

MIT