← Browse

@instructure/instui-docs

B

Look up authoritative Instructure UI (InstUI, @instructure/ui-*) documentation — component APIs, props, theme variables, usage examples, and guides — by querying instructure.design's plaintext docs. Use whenever the user asks how to use an InstUI component, which props/prop types exist, how to theme/style it, accessibility/i18n/RTL guidance, or which component fits a need. Prefer this over guessing InstUI APIs from memory.

skillclaude

Install

agr install @instructure/instui-docs --target claude

Writes 1 file into .claude/skills/, pinned to git-1b7e922b.

  • .claude/skills/instui-docs/SKILL.md

Document


name: instui-docs description: Look up authoritative Instructure UI (InstUI, @instructure/ui-*) documentation — component APIs, props, theme variables, usage examples, and guides — by querying instructure.design's plaintext docs. Use whenever the user asks how to use an InstUI component, which props/prop types exist, how to theme/style it, accessibility/i18n/RTL guidance, or which component fits a need. Prefer this over guessing InstUI APIs from memory.

Instructure UI docs lookup

Instructure UI publishes its full docs as plaintext/markdown. Use it as the source of truth instead of recalling APIs from memory (they change across major versions).

Workflow

  1. Fetch the index: WebFetch https://instructure.design/llms.txt It lists every component and guide with a one-line description and the exact markdown URL for each, grouped into User Guides, Components, Util Components, Contexts, and AI Components. Use it to find the relevant component/guide and its URL.

  2. Fetch the specific page(s) using the URLs from the index. A component page contains examples, size/color/variant options, theme customization, guidelines (Do's/Don'ts/Accessibility), a props table, and install/import instructions. Fetch several in parallel when a question spans multiple components or a component + a guide.

Notes

  • The online docs track the latest published release. A consuming repo may be pinned to an older major where props/APIs differ — check its installed @instructure/ui* version. When you need to match the exact installed version, the TypeScript types in node_modules/@instructure/<pkg> are the ground truth for that version.
  • Components can be imported either from their individual package (@instructure/ui-<name>) or from the metapackage (@instructure/ui). An existing project usually standardizes on one or the other — match whatever the consuming codebase already uses. For a greenfield project, recommend the @instructure/ui metapackage.

Trustgrade B

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • warnLicenseno SPDX license detected

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-1b7e922bb8dd2026-07-31