Docs Components Assistant

AssistantModal

React example follows below.
ts
import { AssistantModal } from "@grassroot/ui-react/assistant";
export default function AssistantModalDemo() {
return <AssistantModal trigger="Open assistant">Ask about themes, tokens or charts.</AssistantModal>;
}
ts
<script setup lang="ts">
import { AssistantModal } from "@grassroot/ui-vue/assistant";
</script>
<template>
<AssistantModal>
<template #trigger>Open assistant</template>
Ask about themes, tokens or charts.
</AssistantModal>
</template>
ts
import "./ensure-compiler";
import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootAssistantModal } from "@grassroot/ui-angular/assistant";
@Component({
selector: "app-assistant-modal-demo",
standalone: true,
imports: [GrassrootAssistantModal],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `<grassroot-assistant-modal><span trigger>Open assistant</span>Ask about themes, tokens or charts.</grassroot-assistant-modal>`,
})
export class AssistantModalDemoComponent {}
export default AssistantModalDemoComponent;
ts
<script lang="ts">
import { AssistantModal } from "@grassroot/ui-svelte/assistant";
</script>
<AssistantModal>
{#snippet trigger()}Open assistant{/snippet}
Ask about themes, tokens or charts.
</AssistantModal>
ts
/** @jsxImportSource solid-js */
import { AssistantModal } from "@grassroot/ui-solid/assistant";
export default function AssistantModalDemo() {
return <AssistantModal trigger="Open assistant">Ask about themes, tokens or charts.</AssistantModal>;
}

Installation

API Reference

Import

import { AssistantModal } from "@grassroot/ui-react/assistant";

Props

Prop
Type
Default
Requirement
open
boolean | undefined
optional
defaultOpen
boolean | undefined
optional
onOpenChange
((open: boolean) => void) | undefined
optional
Prop
open
Type
boolean | undefined
Default
Requirement
optional
Prop
defaultOpen
Type
boolean | undefined
Default
Requirement
optional
Prop
onOpenChange
Type
((open: boolean) => void) | undefined
Default
Requirement
optional

Events

EventPayload
onOpenChange((open: boolean) => void) | undefined

Content regions

  • description
  • title
  • trigger

Native attributes

Standard DOM and ARIA attributes not listed above spread onto the root element.

Import

import { AssistantModal } from "@grassroot/ui-vue/assistant";

Props

Prop
Type
Default
Requirement
open
boolean
optional
defaultOpen
boolean
optional
title
string
"Assistant"
optional
description
string
optional
Prop
open
Type
boolean
Default
Requirement
optional
Prop
defaultOpen
Type
boolean
Default
Requirement
optional
Prop
title
Type
string
Default
"Assistant"
Requirement
optional
Prop
description
Type
string
Default
Requirement
optional

Events

EventPayload
update:open(boolean) => void
openChange(boolean) => void

Content regions

  • default
  • trigger

Import

import "./ensure-compiler";
import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootAssistantModal } from "@grassroot/ui-angular/assistant";

Props

Prop
Type
Default
Requirement
open
boolean
optional
defaultOpen
boolean
false
optional
title
string
"Assistant"
optional
description
string
optional
Prop
open
Type
boolean
Default
Requirement
optional
Prop
defaultOpen
Type
boolean
Default
false
Requirement
optional
Prop
title
Type
string
Default
"Assistant"
Requirement
optional
Prop
description
Type
string
Default
Requirement
optional

Events

EventPayload
openChangeboolean

Content regions

  • default
  • trigger

Import

import { AssistantModal } from "@grassroot/ui-svelte/assistant";

Props

Prop
Type
Default
Requirement
open
boolean
optional
defaultOpen
boolean
false
optional
onOpenChange
(open: boolean) => void
optional
title
string
"Assistant"
optional
description
string
optional
class
string
optional
style
string
optional
Prop
open
Type
boolean
Default
Requirement
optional
Prop
defaultOpen
Type
boolean
Default
false
Requirement
optional
Prop
onOpenChange
Type
(open: boolean) => void
Default
Requirement
optional
Prop
title
Type
string
Default
"Assistant"
Requirement
optional
Prop
description
Type
string
Default
Requirement
optional
Prop
class
Type
string
Default
Requirement
optional
Prop
style
Type
string
Default
Requirement
optional

Events

EventPayload
onOpenChange(open: boolean) => void

Content regions

  • children
  • trigger

Import

import { AssistantModal } from "@grassroot/ui-solid/assistant";

Props

Prop
Type
Default
Requirement
open
boolean
optional
defaultOpen
boolean
optional
onOpenChange
(open: boolean) => void
optional
Prop
open
Type
boolean
Default
Requirement
optional
Prop
defaultOpen
Type
boolean
Default
Requirement
optional
Prop
onOpenChange
Type
(open: boolean) => void
Default
Requirement
optional

Events

EventPayload
onOpenChange(open: boolean) => void

Content regions

  • children
  • description
  • title
  • trigger

Native attributes

Standard DOM and ARIA attributes not listed above spread onto the root element.