button-share

A button to share app state as compressed URL and recover it.

npm i button-share

pnpm add button-share

yarn add button-share

API

# ButtonShareElement

src/button-share.ts#L18

# constructor(args)

# new ButtonShareElement()

ButtonShareElement

# args

any []

# $
src/sigl/dist/types/sigl.d.ts#L25
Context<ButtonShareElement & JsxContext<ButtonShareElement> & Omit<{

# ctor

Class<T>

<T>(ctor)  =>

CleanClass<T>
# ctx

T | Class<T>

<T>(ctx)  =>

Wrapper<T>

} & __module & {

# Boolean

src/sigl/dist/types/index.d.ts#L9

undefined | boolean

# Number

src/sigl/dist/types/index.d.ts#L8

undefined | number

# String

src/sigl/dist/types/index.d.ts#L7

undefined | string

}, "transition">>

# context

src/sigl/dist/types/sigl.d.ts#L26

ContextClass<ButtonShareElement & JsxContext<ButtonShareElement> & Omit<{

# ctor

Class<T>

<T>(ctor)  =>

CleanClass<T>
# ctx

T | Class<T>

<T>(ctx)  =>

Wrapper<T>
} & __module & {
# Boolean

src/sigl/dist/types/index.d.ts#L9

undefined | boolean

# Number

src/sigl/dist/types/index.d.ts#L8

undefined | number

# String

src/sigl/dist/types/index.d.ts#L7

undefined | string

}, "transition">>

# dispatch

src/sigl/dist/types/events.d.ts#L4

Dispatch<

# (name, detail, init)
# name

Event | Narrow<K, string>

# detail

E

# init

CustomEventInit<any>

<K, E>(name, detail, init)  =>

any

>

# enableEndMark  =  false

src/button-share.ts#L20

boolean

# getSerializedState

src/button-share.ts#L23

# ()
()  =>

string

# hashPrefix  =  's='

src/button-share.ts#L21

string

# host

src/sigl/dist/types/sigl.d.ts#L24

ButtonShareElement

# mode  =  9

src/button-share.ts#L19

number

# onmounted

EventHandler<ButtonShareElement, CustomEvent<any>>

# onopened

EventHandler<ButtonShareElement, CustomEvent<{

# serializedState

src/button-share.ts#L11

string

}>>

# onready

EventHandler<ButtonShareElement, CustomEvent<any>>

# onshare

EventHandler<ButtonShareElement, CustomEvent<{

# didWriteClipboard

src/button-share.ts#L8

boolean

}>>

# onunmounted

EventHandler<ButtonShareElement, CustomEvent<any>>

# openURL

src/button-share.ts#L24

# (url)
# url

Location | URL

(url)  =>

void

# created(ctx)

# ctx
Context<ButtonShareElement & JsxContext<ButtonShareElement> & Omit<{

# ctor

Class<T>

<T>(ctor)  =>

CleanClass<T>
# ctx

T | Class<T>

<T>(ctx)  =>

Wrapper<T>
} & __module & {
# Boolean

src/sigl/dist/types/index.d.ts#L9

undefined | boolean

# Number

src/sigl/dist/types/index.d.ts#L8

undefined | number

# String

src/sigl/dist/types/index.d.ts#L7

undefined | string

}, "transition">>

created(ctx)  =>

void

# mounted($)

src/button-share.ts#L26

# $
Context<ButtonShareElement & JsxContext<ButtonShareElement> & Omit<{

# ctor

Class<T>

<T>(ctor)  =>

CleanClass<T>
# ctx

T | Class<T>

<T>(ctx)  =>

Wrapper<T>
} & __module & {
# Boolean

src/sigl/dist/types/index.d.ts#L9

undefined | boolean

# Number

src/sigl/dist/types/index.d.ts#L8

undefined | number

# String

src/sigl/dist/types/index.d.ts#L7

undefined | string

}, "transition">>

mounted($)  =>

void

# on(name)

# name

K

on<K>(name)  =>

On<Fn<[ EventHandler<ButtonShareElement, LifecycleEvents & ButtonShareEvents [K]> ], Off>>

# toJSON()

toJSON()  =>

Pick<ButtonShareElement, keyof ButtonShareElement>

# ButtonShareEvents

src/button-share.ts#L5

{

# opened
src/button-share.ts#L10
CustomEvent<{

# serializedState

src/button-share.ts#L11

string

}>

# ready

src/button-share.ts#L6

CustomEvent

# share

src/button-share.ts#L7

CustomEvent<{

# didWriteClipboard

src/button-share.ts#L8

boolean

}>

}

Credits

• sigl by stagas – Web framework
• urlsafe-lzma by adamrutter – URL-safe LZMA compression

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas