Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @svg-drawing/react

Index

Type Aliases

Functions

Type Aliases

UseSvgDrawing: { ref: RefObject<SvgDrawing | null>; changeClose: any; changeCurve: any; changeDelay: any; changeFill: any; changePenColor: any; changePenWidth: any; clear: any; download: any; getSvgXML: any; undo: any }

Type declaration

  • ref: RefObject<SvgDrawing | null>
  • changeClose:function
    • changeClose(penwidth: undefined | boolean): void
    • Parameters

      • penwidth: undefined | boolean

      Returns void

  • changeCurve:function
    • changeCurve(penwidth: undefined | boolean): void
    • Parameters

      • penwidth: undefined | boolean

      Returns void

  • changeDelay:function
    • changeDelay(penColor: undefined | number): void
    • Parameters

      • penColor: undefined | number

      Returns void

  • changeFill:function
    • changeFill(penColor: undefined | string): void
    • Parameters

      • penColor: undefined | string

      Returns void

  • changePenColor:function
    • changePenColor(penColor: undefined | string): void
    • Parameters

      • penColor: undefined | string

      Returns void

  • changePenWidth:function
    • changePenWidth(penwidth: undefined | number): void
    • Parameters

      • penwidth: undefined | number

      Returns void

  • clear:function
    • clear(): void
    • Returns void

  • download:function
    • download(opt: undefined | DownloadOption): void
    • Parameters

      • opt: undefined | DownloadOption

      Returns void

  • getSvgXML:function
    • getSvgXML(): null | string
    • Returns null | string

  • undo:function
    • undo(): void
    • Returns void

Functions

  • useSvgDrawing(option?: Partial<DrawingOption>): [MutableRefObject<null | HTMLDivElement>, UseSvgDrawing]
  • Parameters

    • Optional option: Partial<DrawingOption>

    Returns [MutableRefObject<null | HTMLDivElement>, UseSvgDrawing]

Generated using TypeDoc