Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.10.0.

Opties

Geef deze door aan whop.chat.create({ … }), of als props op <Chat> in React.
string
Een gebruikerstoken met scopes. Maak er een aan op je server met POST /api/v1/access_tokens en stel met update({ accessToken }) een nieuw token in voordat het verloopt. Kanalen vereisen de scopes chat:read en chat:message:create, directe berichten dms:read, dms:message:manage en dms:channel:manage, en supportchats support_chat:read en support_chat:message:create.
string
Het account-ID waartoe de chat wordt beperkt, met voorvoegsel biz_.
string | null
Het ID van het actieve kanaal, met voorvoegsel feed_ of chat_feed_.
string | null
Het ID van het initieel actieve kanaal, met voorvoegsel feed_ of chat_feed_.
"imessage" | "discord"
De stijl van de chat. Standaard: "imessage".
Appearance
Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale WhopElements({ appearance }). Wijzig het live met update({ appearance }).
WhopElementsLocale
Locale voor de UI-tekst van de elementen in deze groep. Stel deze in op een van de ingebouwde locales van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardlocale.

Events

Geef callbacks door in de create-opties of als React-props.

onChannelChange

Wordt verzonden wanneer het actieve kanaal verandert. Bevat focusMessageId wanneer het kanaal opent met een bericht in focus.
object

onLoadingChange

Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is true zolang een van de gemounte elementen nog laadt.
boolean

Methoden

Roep deze aan op de Chat-handle uit whop.chat.create({ … }) of useChat().

update

Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de props van de namespace. Parameters
Partial<ChatOptions>
vereist

destroy

Vernietigt elk element en elke sub-controller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen ervan vrij. Je kunt dit meer dan eens aanroepen, maar een vernietigde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt unmount.

Elementen

De elementen die deze groep mount. Elk element heeft een eigen pagina:

ChatElement

Een realtime berichtenweergave.

ChannelListElement

Een lijst met de kanalen van de gebruiker.

SearchElement

Een modal om berichten te zoeken in alle kanalen van de gebruiker.