Docs Components Assistant

ContextDisplay

React example follows below.
ts
import { ContextDisplay } from "@grassroot/ui-react/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";
export default function ContextDisplayDemo() {
return <ContextDisplay used={assistantDemoContext.used} limit={assistantDemoContext.total} />;
}
ts
<script setup lang="ts">
import { ContextDisplay } from "@grassroot/ui-vue/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";
</script>
<template>
<ContextDisplay :used="assistantDemoContext.used" :limit="assistantDemoContext.total" />
</template>
ts
import "./ensure-compiler";
import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootContextDisplay } from "@grassroot/ui-angular/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";
@Component({
selector: "app-context-display-demo",
standalone: true,
imports: [GrassrootContextDisplay],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `<grassroot-context-display [used]="used" [limit]="limit" />`,
})
export class ContextDisplayDemoComponent {
protected readonly used = assistantDemoContext.used;
protected readonly limit = assistantDemoContext.total;
}
export default ContextDisplayDemoComponent;
ts
<script lang="ts">
import { ContextDisplay } from "@grassroot/ui-svelte/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";
</script>
<ContextDisplay used={assistantDemoContext.used} limit={assistantDemoContext.total} />
ts
/** @jsxImportSource solid-js */
import { ContextDisplay } from "@grassroot/ui-solid/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";
export default function ContextDisplayDemo() {
return <ContextDisplay used={assistantDemoContext.used} limit={assistantDemoContext.total} />;
}

Installation

API Reference

Import

import { ContextDisplay } from "@grassroot/ui-react/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";

Props

Prop
Type
Default
Requirement
value
number | undefined
optional
used
number | undefined
optional
limit
number | undefined
optional
variant
"text" | "ring" | "bar" | undefined
optional
Prop
value
Type
number | undefined
Default
Requirement
optional
Prop
used
Type
number | undefined
Default
Requirement
optional
Prop
limit
Type
number | undefined
Default
Requirement
optional
Prop
variant
Type
"text" | "ring" | "bar" | undefined
Default
Requirement
optional

Content regions

  • label

Native attributes

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

Import

import { ContextDisplay } from "@grassroot/ui-vue/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";

Props

Prop
Type
Default
Requirement
value
number
optional
used
number
optional
limit
number
optional
variant
"ring" | "bar" | "text"
"bar"
optional
label
string
"Context"
optional
Prop
value
Type
number
Default
Requirement
optional
Prop
used
Type
number
Default
Requirement
optional
Prop
limit
Type
number
Default
Requirement
optional
Prop
variant
Type
"ring" | "bar" | "text"
Default
"bar"
Requirement
optional
Prop
label
Type
string
Default
"Context"
Requirement
optional

Import

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

Props

Prop
Type
Default
Requirement
value
number
optional
used
number
optional
limit
number
optional
variant
"ring" | "bar" | "text"
"bar"
optional
label
string
"Context"
optional
Prop
value
Type
number
Default
Requirement
optional
Prop
used
Type
number
Default
Requirement
optional
Prop
limit
Type
number
Default
Requirement
optional
Prop
variant
Type
"ring" | "bar" | "text"
Default
"bar"
Requirement
optional
Prop
label
Type
string
Default
"Context"
Requirement
optional

Import

import { ContextDisplay } from "@grassroot/ui-svelte/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";

Props

Prop
Type
Default
Requirement
value
number
optional
used
number
optional
limit
number
optional
variant
"ring" | "bar" | "text"
"bar"
optional
label
string
"Context"
optional
class
string
optional
style
string
optional
Prop
value
Type
number
Default
Requirement
optional
Prop
used
Type
number
Default
Requirement
optional
Prop
limit
Type
number
Default
Requirement
optional
Prop
variant
Type
"ring" | "bar" | "text"
Default
"bar"
Requirement
optional
Prop
label
Type
string
Default
"Context"
Requirement
optional
Prop
class
Type
string
Default
Requirement
optional
Prop
style
Type
string
Default
Requirement
optional

Import

import { ContextDisplay } from "@grassroot/ui-solid/assistant";
import { assistantDemoContext } from "@grassroot/demo-fixtures";

Props

Prop
Type
Default
Requirement
value
number
optional
used
number
optional
limit
number
optional
variant
"ring" | "bar" | "text"
optional
label
string
optional
Prop
value
Type
number
Default
Requirement
optional
Prop
used
Type
number
Default
Requirement
optional
Prop
limit
Type
number
Default
Requirement
optional
Prop
variant
Type
"ring" | "bar" | "text"
Default
Requirement
optional
Prop
label
Type
string
Default
Requirement
optional

Content regions

  • children

Native attributes

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