Skip to content

pie-framework/pie-player-components

Repository files navigation

Built With Stencil

Pie Player Components

This package provides Custom Html Elements for using PIE Framework content.

It provides pie-player

<pie-player></pie-player>

For rendering PIE content, and pie-author

<pie-author></pie-author>

For authoring content.

Development

npm install

npm run test

npm run demo - starts stencil in dev mode and launches a http server to serve files in src/demo folder

Debugging

To debug client side code, run stencil tests with the --devtools flag and add a debugger statement in component.tsx code to pause execution. e.g.

npx stencil test --devtools --e2e src/components/pie-player

Documentation

The documentation is auto-generated and placed in docs/ folder and is available on github pages at https://pie-framework.github.io/pie-player-components/

To build the docs: npx stencil build

To view the docs locally: npx http-server docs/