https://github.com/adaptlearning/adapt-component
https://github.com/adaptlearning/adapt-component
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adaptlearning/adapt-component
- Owner: adaptlearning
- License: gpl-3.0
- Created: 2017-09-19T12:36:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T11:48:43.000Z (12 months ago)
- Last Synced: 2025-07-19T14:26:33.911Z (7 months ago)
- Language: JavaScript
- Size: 187 KB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# adapt-component
A basic component skeleton to help developers create components. All components should have a readme that contains the following:
* Title and Description
* Installation
* Usage
* Settings overview
* Limitations
* Browser spec
Further details on developing components can be found on the [wiki](https://github.com/adaptlearning/adapt_framework/wiki) here: [Developing-plugins](https://github.com/adaptlearning/adapt_framework/wiki/Developers-guide:-components).
## Installation
Please describe the steps required to install your plug-in. You should also detail any dependencies that are not part of the package.json file.
## Usage
Some details of how the plug-in might be used should be given here.
## Settings overview
Each component should come with an example.json which contains an example of the data structure needed for this component to work. This enables developers to copy this over without the need for an editor.
Developers should give some description for data expected for their component and what the setting does. The example.json file for a basic component would contain at least the following:
```
{
"_id": "c-05",
"_parentId": "b-05",
"_type": "component",
"_component": "adapt-my-component",
"_classes": "",
"_layout": "left",
"title": "My Component",
"displayTitle": "My Component",
"body": "",
"instruction": ""
}
```
A description of the core settings can be found at: [Core model attributes](https://github.com/adaptlearning/adapt_framework/wiki/Core-model-attributes)
### Data description
All attributes for your component should be described here. A description for core attributes can be found here: [Core model attributes](https://github.com/adaptlearning/adapt_framework/wiki/Core-model-attributes)
Each component should also contain a properties.schema file. This is a JSON schema of example.json. This file is needed for the component to work with the authoring tool. It describes what fields are needed to edit the component.
## Limitations
Please detail any limitation of your component.
## Browser spec
If you have a detailed browser spec you should list them here so that it is clear which browsers you have tested against.