Element Library: Difference between revisions
From MoodleDocs
Damyon Wiese (talk | contribs) (Created page with " {{Infobox Project |name = Element Library |state = Specification |tracker = https://tracker.moodle.org/browse/MDL-45770 |discussion = https://moodle.org/mod/forum/discuss.php...") |
Damyon Wiese (talk | contribs) No edit summary |
||
| Line 10: | Line 10: | ||
{{Work in progress}} | {{Work in progress}} | ||
The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are: | |||
* Themers, used to test all the existing renderables in a newly developed theme | |||
* Developers, used to see an organized list of all the renderables that can be used when building new pages (and the docs for them) | |||
The requirements for this tool are: | |||
* Show a list of renderables / renderer methods for a specific component | |||
* Show the same renderable / renderer method rendered with different test data | |||
* Show designer docs on the recommended usage of a specific element | |||
* Allow easy testing in LTR/RTL and different screen sizes | |||
* Direct links to the documentation for renderers / renderables | |||
Some optional requirements: | |||
* Perform some checks on the renderer to verify it contains no db queries etc | |||
* Responsive testing in the tool (shortcuts to adjust the window size) | |||
* Testing with different language directions | |||
* Report on the list of renderables used by a renderable / renderer method | |||
This tool will work by quering a core api for getting a list of renderer_test instances from each plugin. The renderer_test is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable. | |||
== Related links == | == Related links == | ||
* [[Render library specification]] | * [[Render library specification]] | ||
Revision as of 07:28, 5 June 2014
| Element Library | |
|---|---|
| Project state | Specification |
| Tracker issue | https://tracker.moodle.org/browse/MDL-45770 |
| Discussion | https://moodle.org/mod/forum/discuss.php?d=261202 |
| Assignee | Damyon, Sam |
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:
- Themers, used to test all the existing renderables in a newly developed theme
- Developers, used to see an organized list of all the renderables that can be used when building new pages (and the docs for them)
The requirements for this tool are:
- Show a list of renderables / renderer methods for a specific component
- Show the same renderable / renderer method rendered with different test data
- Show designer docs on the recommended usage of a specific element
- Allow easy testing in LTR/RTL and different screen sizes
- Direct links to the documentation for renderers / renderables
Some optional requirements:
- Perform some checks on the renderer to verify it contains no db queries etc
- Responsive testing in the tool (shortcuts to adjust the window size)
- Testing with different language directions
- Report on the list of renderables used by a renderable / renderer method
This tool will work by quering a core api for getting a list of renderer_test instances from each plugin. The renderer_test is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable.
