{"id":21065617,"url":"https://github.com/adaptlearning/adapt-contrib-resources","last_synced_at":"2025-05-16T02:33:26.353Z","repository":{"id":14789126,"uuid":"17511103","full_name":"adaptlearning/adapt-contrib-resources","owner":"adaptlearning","description":"An extension to allow learners to view resources","archived":false,"fork":false,"pushed_at":"2025-05-14T11:34:53.000Z","size":361,"stargazers_count":4,"open_issues_count":4,"forks_count":20,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-05-14T12:43:27.306Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"garrows/browser-serialport","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adaptlearning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-03-07T10:46:32.000Z","updated_at":"2025-05-14T11:34:55.000Z","dependencies_parsed_at":"2023-10-12T21:24:51.802Z","dependency_job_id":"775f6804-dba7-4a65-99b6-e457cb7bd0c4","html_url":"https://github.com/adaptlearning/adapt-contrib-resources","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-resources","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-resources/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-resources/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-resources/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adaptlearning","download_url":"https://codeload.github.com/adaptlearning/adapt-contrib-resources/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254456360,"owners_count":22074157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T17:55:49.112Z","updated_at":"2025-05-16T02:33:26.346Z","avatar_url":"https://github.com/adaptlearning.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# adapt-contrib-resources\n\n**Resources** is an *extension* bundled with the [Adapt framework](https://github.com/adaptlearning/adapt_framework).\n\u003cimg src=\"https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/resources01.gif\" alt=\"Resources in action\"\u003e\n\n**Resources** provides a way to present extra materials to the learner that is outside of content flow. **Resources** takes advantage of the Drawer\u0026mdash;a panel that slides out from the right-hand side of the page. It is always accessible to the learner through an icon in the navigation bar. **Resources** organises links to documents such as PDFs, links to media, and links to other web resources.\n\n[Visit the **Resources** wiki](https://github.com/adaptlearning/adapt-contrib-resources/wiki) for more information about its functionality.\n\n## Installation\n\nAs one of Adapt's *[core extensions](https://github.com/adaptlearning/adapt_framework/wiki/Core-Plug-ins-in-the-Adapt-Learning-Framework#extensions),* **Resources** is included with the [installation of the Adapt framework](https://github.com/adaptlearning/adapt_framework/wiki/Manual-installation-of-the-Adapt-framework#installation) and the [installation of the Adapt authoring tool](https://github.com/adaptlearning/adapt_authoring/wiki/Installing-Adapt-Origin).\n\n* If **Resources** has been uninstalled from the Adapt framework, it may be reinstalled.\nWith the [Adapt CLI](https://github.com/adaptlearning/adapt-cli) installed, run the following from the command line:\n`adapt install adapt-contrib-resources`\n\n    Alternatively, this component can also be installed by adding the following line of code to the *adapt.json* file:\n    `\"adapt-contrib-resources\": \"*\"`\n    Then running the command:\n    `adapt install`\n    (This second method will reinstall all plug-ins listed in *adapt.json*.)\n\n* If **Resources** has been uninstalled from the Adapt authoring tool, it may be reinstalled using the [Plug-in Manager](https://github.com/adaptlearning/adapt_authoring/wiki/Plugin-Manager).\n\n\u003cdiv float align=right\u003e\u003ca href=\"#top\"\u003eBack to Top\u003c/a\u003e\u003c/div\u003e\n\n## Settings\n\nThe attributes listed below are used in *course.json* to configure **Resources**, and are properly formatted as JSON in [*example.json*](https://github.com/adaptlearning/adapt-contrib-resources/blob/master/example.json). Some attributes can also be overridden for each content object in *contentObjects.json* (see [*example.json*](https://github.com/adaptlearning/adapt-contrib-resources/blob/master/example.json)).\n\nVisit the [**Resources** wiki](https://github.com/adaptlearning/adapt-contrib-resources/wiki) for more information about how they appear in the [authoring tool](https://github.com/adaptlearning/adapt_authoring/wiki).\n\n**\\_resources** (object): The Resources object that contains values for **title**, **description**, **\\_filterButtons**, **\\_filterAria**, and **\\_resourcesItems**.\n\n\u003e**\\_isEnabled** (boolean): Turns **Resources** on and off. Acceptable values are `true` and `false`.\n\n\u003e**\\_drawerOrder** (number): Determines the order in which this extension appears as a drawer item. Acceptable values are numbers.\n\n\u003e**title** (string): This text is displayed (along with the **description**) in the [Drawer](https://github.com/adaptlearning/adapt_framework/wiki/Core-modules#drawer) as part of a button that gives access to the resources. This property only shows when more than one extension is using the drawer.\n\n\u003e**description** (string): This text is displayed (along with the **title**) in the [Drawer](https://github.com/adaptlearning/adapt_framework/wiki/Core-modules#drawer) as part of a button that gives access to the resources. This property only shows when more than one extension is using the drawer.\n\n\u003e**displayTitle** (string): The title for the resources which displays at the top of the resources drawer.\n\n\u003e**body** (string): The body text for the resources which displays at the top of the resources drawer.\n\n\u003e**instruction** (string): The instruction text for the resources which displays at the top of the resources drawer.\n\n\u003e**\\_enableFilters** (boolean): Turns the filter buttons on and off. Acceptable values are `true` and `false`. Defaults to `true`. Note that the filter buttons will be automatically disabled if all `_resourcesItems` items have the same `_type` value.\n\n\u003e**\\_filterButtons** (object):  This attribute group maintains the labels for the four buttons that filter resources by type. It contains values for **all**, **document**, **media**, and **link**.\n\n\u003e\u003e**all** (string): This text appears on the button that returns all **\\_resourcesItems**.\n\n\u003e\u003e**document** (string): This text appears on the filter button that returns **\\_resourcesItems** with `\"_type\": \"document\"`.\n\n\u003e\u003e**media** (string): This text appears on the filter button that returns **\\_resourcesItems** with `\"_type\": \"media\"`.\n\n\u003e\u003e**link** (string): This text appears on the filter button that returns **\\_resourcesItems** with `\"_type\": \"link\"`.\n\n\u003e**\\_filterAria** (object): This attribute group maintains the Aria labels for the four buttons that filter resources by type. It contains values for **allAria**, **documentAria**, **mediaAria**, and **linkAria**.\n\n\u003e\u003e**allAria** (string): This text is associated with the button that returns all **\\_resourcesItems** and is read by assistive technologies.\n\n\u003e\u003e**documentAria** (string): This text is associated with the button that returns **\\_resourcesItems** with `\"_type\": \"document\"`and is read by assistive technologies.\n\n\u003e\u003e**mediaAria** (string): This text is associated with the button that returns **\\_resourcesItems** with `\"_type\": \"media\"`and is read by assistive technologies.\n\n\u003e\u003e**linkAria** (string): This text is associated with the button that returns **\\_resourcesItems** with `\"_type\": \"link\"`and is read by assistive technologies.\n\n\u003e**itemAriaExternal** (string): This text is associated with each resource item. It renders as part of the aria label to tell screen readers that the content will open in an external link.\n\n\u003e**\\_resourcesItems** (object):  This object stores properties for each resource item. Multiple resource items may be created. Each contains values for **\\_type**, **title**, **description** (optional), **\\_link**, **filename** and **\\_forceDownload**. In *course.json*, **\\_isGlobal** is also available.\n\n\u003e\u003e**\\_type** (string):  This text is used to filter resources. If the resource is to be returned in a filtered group, this value must be one of the following: `document`, `media`, `link`, or one of the ten custom types (ex. `custom1`, `custom2`). (Note: There is no file type validation as part of **Resources**.)\n\n\u003e\u003e**title** (string):  This text appears (along with **description**) as a label on the button that links to the item.\n\n\u003e\u003e**description** (string):  This optional text appears (along with **title**) as a label on the button that links to the item.\n\n\u003e\u003e**\\_link** (string):  Path to the resource item, e.g., *course/en/pdf/diagram.pdf*.\n\n\u003e\u003e**filename** (string): Allows the name of the downloaded file to be different to that of the source filename. Note that this feature only works in browsers that support the [`download` attribute](https://caniuse.com/#search=download) and is mainly intended for Adapt Authoring Tool users.\n\n\u003e\u003e**\\_forceDownload** (boolean): Forces the resource to be downloaded rather than opened in a new window. Defaults to `false`. Note that this feature only works in browsers that support the [`download` attribute](https://caniuse.com/#search=download) and only with resources that are part of the course content or available from a [same-origin URL](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy)\n\n\u003e\u003e**\\_isGlobal** (boolean): If `true`, the item will appear on every page including the menu. When `false`, the item only appears on the menu. Defaults to `true`. Only available in *course.json*.\n\n\u003cdiv float align=right\u003e\u003ca href=\"#top\"\u003eBack to Top\u003c/a\u003e\u003c/div\u003e\n\n## Limitations\n\nNo known limitations.\n\n----------------------------\n\u003ca href=\"https://community.adaptlearning.org/\" target=\"_blank\"\u003e\u003cimg src=\"https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg\" alt=\"Adapt Learning logo\" align=\"right\"\u003e\u003c/a\u003e\n**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-resources/graphs/contributors)\u003cbr\u003e\n**Accessibility support:** WAI AA\u003cbr\u003e\n**RTL support:** Yes\u003cbr\u003e\n**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, Safari for macOS/iOS/iPadOS, Opera\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-resources","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadaptlearning%2Fadapt-contrib-resources","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-resources/lists"}