@instructure/platform-learning-agent

Initial React package scaffold for the Learning Agent user experience.

Features

• Host-agnostic React component package
• InstUI-based starter component
• Storybook story for local development
• Vitest + Testing Library test setup
• TypeScript declaration output via Vite build

Installation

pnpm add @instructure/platform-learning-agent

Peer Dependencies

{
  "react": "^18.0.0",
  "@instructure/ui-*": "^10.0.0"
}

Usage

import { LearningAgent } from '@instructure/platform-learning-agent'
import '@instructure/platform-learning-agent/styles'

export function Example() {
  return <LearningAgent defaultPath="/dashboard" />
}

API

• defaultPath?: string
  • Initial in-memory route for the agent.
  • Supported paths: /dashboard, /history, /chats/:id (for example /chats/42).

Development

# Run tests
pnpm test

# Run tests with coverage
pnpm test --coverage

# Build
pnpm build

# Type check
pnpm type-check