{"id":42117479,"url":"https://github.com/cgkineo/adapt-search","last_synced_at":"2026-01-26T14:11:19.686Z","repository":{"id":18731672,"uuid":"21943091","full_name":"cgkineo/adapt-search","owner":"cgkineo","description":"Keyword-search extension for Adapt","archived":false,"fork":false,"pushed_at":"2025-11-03T18:22:07.000Z","size":393,"stargazers_count":4,"open_issues_count":0,"forks_count":10,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-11-03T20:24:13.076Z","etag":null,"topics":["adapt","extension"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cgkineo.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-07-17T13:34:45.000Z","updated_at":"2025-11-03T18:22:10.000Z","dependencies_parsed_at":"2024-07-15T09:26:49.439Z","dependency_job_id":null,"html_url":"https://github.com/cgkineo/adapt-search","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/cgkineo/adapt-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgkineo%2Fadapt-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgkineo%2Fadapt-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgkineo%2Fadapt-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgkineo%2Fadapt-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cgkineo","download_url":"https://codeload.github.com/cgkineo/adapt-search/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgkineo%2Fadapt-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28780339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T13:55:28.044Z","status":"ssl_error","status_checked_at":"2026-01-26T13:55:26.068Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["adapt","extension"],"created_at":"2026-01-26T14:11:18.938Z","updated_at":"2026-01-26T14:11:19.674Z","avatar_url":"https://github.com/cgkineo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# adapt-search\n**Search** is an *extension* plugin for the [Adapt framework](https://github.com/adaptlearning/adapt_framework).\n\n\u003cimg src=\"https://raw.githubusercontent.com/wiki/cgkineo/adapt-search/images/example.gif\" alt=\"sample search extension\"\u003e\n\nThe search extension displays in the Adapt 'drawer', either as a single item or with other items - such as the [resources plugin](https://github.com/adaptlearning/adapt-contrib-resources).\n\n## Installation\nTo install this extension using the Adapt CLI, run `adapt install adapt-search`\n\n## Settings Overview\nThe search extension's main configuration should be added to *course.json*. Additional configuration of search 'keywords' may be included on contentObjects, articles, blocks and components.\n\n## General Attributes\nThe attributes listed below are used in *course.json* to configure **Search**, and are properly formatted as JSON in [*example.json*](https://github.com/cgkineo/adapt-search/blob/master/example.json).\n\n### title (string):\nExtension title, defaults to `\"Search\"`.\n\n### placeholder (string):\nSearch field text box 'placeholder' text, defaults to `\"\"`.\n\n### description (string):\nExtension description, defaults to `\"Type in search words\"`.\n\n### \\_drawerOrder (number):\nDetermines the order in which this extension appears as a drawer item. You only need to set this if your course has more than one extension that appears in the drawer (e.g. [glossary](https://github.com/adaptlearning/adapt-contrib-glossary), [resources](https://github.com/adaptlearning/adapt-contrib-resources)) and you want to control the order in which they are listed when the drawer is opened.\n\n### noResultsMessage (string):\nText displayed when no results are found, defaults to `\"Sorry, no results were found\"`.\n\n### awaitingResultsMessage (string):\nMessage between having enough characters to search and having search results (More than 2 characters per word). Defaults to `\"Formulating results...\"`.\n\n### \\_showHighlights (boolean):\nShow the yellow highlights on search results. Defaults to `true`.\n\n### \\_showFoundWords (boolean):\nShow found words under the search results. Defaults to `true`.\n\n### \\_previewWords (integer):\nThe number of words taken from either side of the matching word. Defaults to `15`.\n\n### \\_previewCharacters (integer):\nIf the number of `_previewWords` cannot be found then use `x` number of characters. Defaults to `30`.\n\n## Item Attributes\nThe attributes listed below are used in *contentObject.json*, *articles.json*, *blocks.json* and *components.json* to configure **Search Items**, and are properly formatted as JSON in [*example.json*](https://github.com/cgkineo/adapt-search/blob/master/example.json).\n\n### \\_search (object): \nContainer object for the `keywords` setting\n\n### title (string): \nAlternative title for search result.\n\n### keywords (array): \nA list of search keywords/phrases to be associated with the contentObject/article/block/component. Each item in the array must be a string.\n**NOTE**: Keywords are exported with the `grunt translate:export` command. When localising content, use a process that ensures translated keywords are found in the actual translated course content.\n\n\u003cdiv float align=right\u003e\u003ca href=\"#top\"\u003eBack to Top\u003c/a\u003e\u003c/div\u003e\n\n## Limitations\nNo known limitations.\n\n----------------------------\n  \n**Framework versions:** 5.8+\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\u003cbr\u003e\n**Author / maintainer:** Kineo and community with [contributors](https://github.com/cgkineo/adapt-search/graphs/contributors)\u003cbr\u003e\n**Accessibility support:** WAI AA\u003cbr\u003e\n**RTL support:** No\u003cbr\u003e\n**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcgkineo%2Fadapt-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcgkineo%2Fadapt-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcgkineo%2Fadapt-search/lists"}