Skip to content
LyEve UI v0.60.1

Feedback

GateNotice

What a page shows in place of a read that was refused or failed, drawn the same way on every page. The page maps the server's answer to one state of the exported Gate type and passes every sentence in its own words. A read that answered draws nothing.

Every state

absent, full, forbidden, busy and unavailable draw a warning or brand Alert from words. Only error is drawn as a failure, with the message the gate carries. locked renders the page's own locked snippet with the link forward the gate carried. Only busy, unavailable and error, the states that waiting can change, offer the retry link. A role does not change on a retry, so forbidden offers nothing to press, and full offers no link because only the page knows a way past its ceiling.

absent

The cache is not part of this build, so nothing is cached.

locked

Caching is not enabled

full

forbidden

busy

unavailable

error

Try again

The retry is a plain link to retryHref, usually the page's own path and query, so it works before the page hydrates. It carries data-sveltekit-reload, because a SvelteKit router keeps the data it holds for an address that did not change, and the link has to ask for a fresh document. Other hosts ignore the attribute. The link's label is words.retry.

API

PropTypeDefaultDescription
gate requiredGate no defaultThe state the page mapped from the server answer. ok draws nothing.
words requiredGateWords no defaultEvery sentence the notice can draw, in the page's words.
locked requiredSnippet<[forwardHref: string]> no defaultDrawn for a feature that is not enabled, given the link forward the gate carried.
retryHref requiredstring no defaultThe address that asks for this page again, usually its own path and query.
class string no defaultExtra classes on the wrapper.

Gate

PropTypeDefaultDescription
ok { state: 'ok' } no defaultThe read answered. Nothing is drawn.
absent { state: 'absent' } no defaultThe route is not there.
locked { state: 'locked'; forwardHref: string } no defaultNot enabled here. forwardHref is where it is turned on.
full { state: 'full'; limit: number | null; current: number | null } no defaultAt a capacity ceiling. The numbers are for the page to put into its words, and either is null when the server sent none.
forbidden { state: 'forbidden' } no defaultThe reader's role may not read it.
busy { state: 'busy' } no defaultRefused for the request rate. The same read succeeds once the window passes.
unavailable { state: 'unavailable' } no defaultThe server or its database did not answer.
error { state: 'error'; message: string } no defaultThe read failed. The message is drawn as a failure.

GateWords

The kit holds none of these sentences, so each console says a refusal its own way and in its own language. GateText is a title and the body under it.

PropTypeDefaultDescription
absent requiredstring no defaultWhat a missing route means here.
full requiredGateText no defaultA capacity ceiling, with the numbers already in the body.
forbidden requiredstring no defaultA role that may not read it, and who to ask.
busy requiredGateText no defaultA refusal for the request rate.
unavailable requiredGateText no defaultA server or database that did not answer.
retry requiredstring no defaultThe label of the link that asks for the page again.