bslibreact (JavaScript) - v0.1.0
    Preparing search index...

    Interface ShinyGlobal

    interface ShinyGlobal {
        addCustomMessageHandler: (
            type: string,
            handler: (message: unknown) => void,
        ) => void;
        bindAll: (scope: Element | Document) => void | Promise<void>;
        initializedPromise?: Promise<void>;
        initializeInputs: (scope: Element | Document) => void;
        setInputValue: (name: string, value: unknown, opts?: InputOpts) => void;
        shinyapp?: { $inputValues: Record<string, unknown> };
        unbindAll: (scope: Element | Document, includeSelf?: boolean) => void;
    }
    Index
    addCustomMessageHandler bindAll initializedPromise? initializeInputs setInputValue shinyapp? unbindAll
    addCustomMessageHandler: (
        type: string,
        handler: (message: unknown) => void,
    ) => void

    Shiny.addCustomMessageHandler(type, handler): the client half of session$sendCustomMessage(type, ...) on the server. A port reaches for this when the parent's own UI had an inline tags$script(HTML("Shiny.addCustomMessageHandler(...)")) driving a plain DOM effect (opening an offcanvas, say) that isn't itself a hosted input or output.

    bindAll: (scope: Element | Document) => void | Promise<void>
    initializedPromise?: Promise<void>
    initializeInputs: (scope: Element | Document) => void
    setInputValue: (name: string, value: unknown, opts?: InputOpts) => void
    shinyapp?: { $inputValues: Record<string, unknown> }

    The last value of every bound input, keyed by id (sometimes with a ":" suffix). Read by useHostedInputValue for its first value.

    unbindAll: (scope: Element | Document, includeSelf?: boolean) => void

    Settings
    Member Visibility

    On This Page
    Properties