Skip to main content

UseChannel

useChannel​

@vendure/dashboarduse-channel.ts
v3.3.0

Status: Developer Preview

Provides access to the ChannelContext which contains information about the active channel.

Signature
function useChannel(): void

ChannelContext​

@vendure/dashboardchannel-provider.tsx
v3.3.0

Status: Developer Preview

Signature
interface ChannelContext {
    activeChannel: ActiveChannel | undefined;
    channels: Channel[];
    selectedChannelId: string | undefined;
    selectedChannel: Channel | undefined;
    isLoading: boolean;
    setSelectedChannel: (channelId: string) => void;
}

activeChannel​

property
ActiveChannel | undefined

channels​

property
Channel[]

selectedChannelId​

property
string | undefined

selectedChannel​

property
Channel | undefined

isLoading​

property
boolean

setSelectedChannel​

property
(channelId: string) => void