Guides and reference: Docs
Docs
Guides and reference
Integration guides, learner tools and API reference, with links to the source documentation.
Start here
Delivery and integration
Install and load PIE
Load elements from a bundle host, as browser ESM, or from your own build.
Items, elements and schemas
Validate models, editor settings and response data with JSON Schemas.
Save and resume
Save responses and restore an attempt.
Scoring and rubrics
Score responses in the browser or on a server, with partial credit and rubrics.
Backend integration
Connect content, response storage and scoring to a server.
Custom section layouts
Build a layout using the standard item and passage panes.
Launch from an LTI host
Connect an LMS launch to the players and grade passback.
Tools and learner supports
Tools catalog
Reading aids, calculators, annotation and reference tools.
Tool placement and profiles
Control which tools are available to each learner.
Tool and calculator providers
Load tools and configure Desmos, GeoGebra or Cortex.
Read-aloud
Configure speech, recordings and synchronized text highlights.
Accessible content alternatives
Add spoken alternatives, transcripts and signed video to content.
Experience and operations
Accessibility and evidence
Learner supports, WCAG testing and known issues.
Themes and branding
Set colors, fonts and learner color schemes.
Localization
Set interface and content languages.
Math rendering
Configure MathJax and accessible math for each loading option.
Secure delivery and CSP
Protect answer keys, score on a server and configure CSP.
Instrumentation and debugging
Inspect events and errors, and connect a telemetry provider.
Troubleshooting
Diagnose loading, tool, response, speech and styling problems.
Reference and upgrades
Migrate legacy players
Move from pie-player-components to the unified item player.
Versions and upgrades
Pin compatible player and element versions, and plan upgrades.
Packages and entry points
Package imports for browsers, bundlers and servers.
Item player API
Attributes, properties, methods, events, authoring and backend contracts.
Section player API
Layout inputs, controller methods, session lifecycle and readiness events.
Toolkit API
Coordinator, services, item scopes and tool state.
Tool registry API
Register tools, content surfaces, activation models and host actions.
Element package contract
Requirements for element data, views, events and packaging.