@citolab/qti-components

@citolab/qti-components is a web component library that can be used to render 1EdTech QTI items. It's highly customizable and can be integrated in almost every web application.

Installation

CDN

Import the components with the CDN version

<script type="module">
  import 'https://unpkg.com/@citolab/qti-components/cdn';
</script>

NPM

Or use npm to install the package:

npm install @citolab/qti-components

To use @citolab/qti-components, you need to register the web components. By registering the web components, the browser knows how to display the item and create a fully functional test.

import '@citolab/qti-components';

Branch Preview Via StackBlitz

For pull requests, a bot comment includes one-click StackBlitz links that open the PR branch and start Storybook in-browser. Setup details and manual URL templates are documented in docs/publishing.mdx.

Contributing

Contributions are welcome! Please follow these guidelines when contributing:

• Fork the repository and clone it to your local machine
• Create a new branch for your feature or bug fix
• Commit your changes with clear and concise messages
• Push your changes to your forked repository
• Open a pull request to the original repository

Publishing

Release and publish workflow details are documented in docs/publishing.mdx. Automated releases use Changesets on main.

Third-Party Components

Note: This repository includes some third-party components solely for showcasing PCIs in Storybook. These components are not included in the published npm package. For licensing details, refer to the LICENSE file in the third-party directory.

License

This project is licensed under the GPLv3 License.

Please note that the licensing is GPLv3 if you want to use it in another way, feel free to ask!