Module

Solid.Router.Search

Package
purescript-purs-solid
Repository
arazorda/purs-solid

Typed query params. A schema row declares each param as a Maybe or an Array of String, Int or Boolean; values that don't parse read as Nothing or are left out.

search <- useSearch @(page :: Maybe Int, tag :: Array String)
text (show <<< _.page <$> searchParams search)
setSearch search { page: Just 2 }

#Search Source

data Search :: Row Type -> Typedata Search t0

The current location's query params, read and written with schema r.

#useSearch Source

useSearch :: forall @r rl. RowToList r rl => SearchFields rl => Setup (Search r)

#searchParams Source

searchParams :: forall r. Search r -> Accessor (Record r)

#setSearch Source

setSearch :: forall r given missing. Union given missing r => Search r -> Record given -> Effect Unit

Sets the given params; Nothing or [] removes one. Params not given stay.

#setSearchWith Source

setSearchWith :: forall r given missing options optionsMissing. Union given missing r => Union options optionsMissing NavigateOptions => Record options -> Search r -> Record given -> Effect Unit

Takes any subset of NavigateOptions.

#SearchField Source

class SearchField a  where

A param can always be missing, so it's a Maybe (the first value) or an Array (every value).

Members

Instances

#SearchFields Source

#SearchFieldCodec Source

type SearchFieldCodec = { name :: String, read :: Array String -> SearchFieldValue, write :: SearchFieldValue -> Array String }

#SearchFieldValue Source