{"id":13847549,"url":"https://github.com/alphagov/govuk_frontend_toolkit","last_synced_at":"2025-05-15T23:02:32.273Z","repository":{"id":4297087,"uuid":"5428163","full_name":"alphagov/govuk_frontend_toolkit","owner":"alphagov","description":"❗️GOV.UK Frontend Toolkit is deprecated, and will only receive major bug fixes and security patches.","archived":false,"fork":false,"pushed_at":"2021-06-25T08:56:01.000Z","size":1139,"stargazers_count":403,"open_issues_count":0,"forks_count":104,"subscribers_count":124,"default_branch":"master","last_synced_at":"2025-05-08T22:51:33.748Z","etag":null,"topics":["deprecated","govuk-design-system-team","govuk-frontend","portfolio"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alphagov.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-08-15T16:02:20.000Z","updated_at":"2025-02-17T19:20:48.000Z","dependencies_parsed_at":"2022-09-13T17:51:17.990Z","dependency_job_id":null,"html_url":"https://github.com/alphagov/govuk_frontend_toolkit","commit_stats":null,"previous_names":[],"tags_count":96,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk_frontend_toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk_frontend_toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk_frontend_toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fgovuk_frontend_toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphagov","download_url":"https://codeload.github.com/alphagov/govuk_frontend_toolkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436932,"owners_count":22070944,"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":["deprecated","govuk-design-system-team","govuk-frontend","portfolio"],"created_at":"2024-08-04T19:00:20.523Z","updated_at":"2025-05-15T23:02:32.246Z","avatar_url":"https://github.com/alphagov.png","language":"JavaScript","funding_links":[],"categories":["Deprecated","JavaScript"],"sub_categories":["Core libraries"],"readme":"The GOV.UK Design System launched on 22 June 2018\n===============\n\nGOV.UK Frontend Toolkit:\n\n- is no longer maintained\n- will only be updated for major bug fixes and security patches\n- does not meet the [Web Content Accessibility Guidelines (WCAG 2.1 level AA) accessibility standard](https://www.gov.uk/guidance/accessibility-requirements-for-public-sector-websites-and-apps#meeting-accessibility-requirements)\n\nThis framework will remain available in case you’re currently using it. To help your service meet accessibility requirements, you should use the [GOV.UK Design System](https://design-system.service.gov.uk/). You can [migrate to the Design System from GOV.UK Frontend Toolkit](https://frontend.design-system.service.gov.uk/migrating-from-legacy-products/).\n\n# GOV.UK frontend toolkit\n\nA collection of Sass and JavaScript files for using as part of your\napplication's frontend.\n\nThis project is not tied to a specific language and is designed to be used\nas a dependency in as many different languages as needed.\n\nThere's a `Gemfile` and a `package.json` in this directory, but they are only\nfor running tests and are not an indication that this project prefers\nRuby or Node.js.\n\n## Installing\n\n### Ruby on Rails\n\nWe recommend you use the [govuk_frontend_toolkit_gem][toolkit_gem_github] and\nfollow the [installation instructions][toolkit_gem_github_readme].\n\n[toolkit_gem_github]: https://github.com/alphagov/govuk_frontend_toolkit_gem\n[toolkit_gem_github_readme]: https://github.com/alphagov/govuk_frontend_toolkit_gem#readme\n\n### Node.js\n\n[govuk_frontend_toolkit_npm][toolkit_npm_github] is an NPM package that can be\n[installed or included in your package.json][toolkit_npm].\n\n[toolkit_npm_github]: https://github.com/alphagov/govuk_frontend_toolkit_npm\n[toolkit_npm]: https://npmjs.org/package/govuk_frontend_toolkit\n\nIf you are using a build tool that depends on Libsass then you\nmay need to upgrade to a more recent version to use the grid helpers. Minimal\ncompatible versions include `node-sass` 1.0.0, `grunt-sass` 0.16.0,\n`gulp-sass` 1.2.0 and `libsass` 3.0.0.\n\n### Django\n\nRequirement: [NodeJS](https://nodejs.org/en/) installed. This gives you [Node Package Manager](https://docs.npmjs.com/getting-started/installing-node)(NPM) which is required to install npm packages.\n\nThe easiest way to integrate it would be to create a `package.json` file in your application with `npm init`\n\nYou then install the toolkit with `npm install --save govuk_frontend_toolkit`.\nIf you need javascript files, they will live in (`node_modules/govuk_frontend_toolkit/javascripts`).\nIf you need stylesheets they will live in (`node_modules/govuk_frontend_toolkit/stylesheets`).\n\nWith Django you can use https://github.com/jrief/django-sass-processor to compile Sass files.\n\nNote: if you need complete styles you might want to install govuk-elements-sass package that also installs toolkit\n\n### Other projects\n\n#### Using the tagged versions\n\nEach version of the toolkit is tagged with the version number in this format:\n\n`v*version number*`, for example `v4.1.1` for version 4.1.1.\n\nIf your dependency management tool allows the use of Git repositories as dependencies, you can point to a version by using its tag.\n\nFor example, if you are using [bower](http://bower.io), you can add the toolkit to your `bower.json` like so:\n\n`\"govuk_frontend_toolkit\": \"git://github.com/alphagov/govuk_frontend_toolkit#v4.1.1\"` (assuming you want version 4.1.1)\n\n#### Using git submodules\n\nYou can include the toolkit as a [git submodule][git submodule].\n\n[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules\n\nTo add the submodule to your project run the following command substituting the path to a subdirectory in your project's assets directory:\n\n    $ git submodule add https://github.com/alphagov/govuk_frontend_toolkit.git ./path/to/assets/govuk_frontend_toolkit\n\nWe recommend you use `https` rather than `ssh` for submodules as they don't require key exchanges when deploying to remote servers.\n\nIf you clone a project with the toolkit submodule installed you will need to initialise the submodule with the following command:\n\n    $ git submodule init\n\nTo update the toolkit to the latest version you can use:\n\n    $ git submodule update\n\n## Running tests\n\nTests for this project use Jasmine for the JavaScript and Ruby's `scss` and `scss-lint`\nto check the stylesheets.\n\nThe requirements are Node.js 0.8 or higher and PhantomJS, and Ruby:\n\n```bash\nbundle install\nnpm install\nnpm test\n```\n\n### Standard JavaScript\n`govuk_frontend_toolkit` uses [standardjs](http://standardjs.com/), an opinionated JavaScript linter.\nAll JavaScript files follow its conventions. [Read more](https://github.com/alphagov/govuk_prototype_kit/blob/master/docs/linting.md)\n\n### Using the local test runner\n\nThe test suite can be run by opening the `./spec/support/LocalTestRunner.html` file in a browser for a more detailed trace of errors.\n\nThe files for unit tests and any supporting JavaScript should be added to `./spec/manifest.js` file.\n\n## Usage\n\nAt the top of a Sass file in your project you should use an `@import` rule\nto include the file for the mixins you require, eg if you want the\nconditionals and typography mixins you should add:\n\n    @import '_conditionals';\n    @import '_typography';\n\nYou may need to include the relative path to the toolkit if it is installed as a submodule:\n\n    @import '../toolkit/_conditionals';\n\nIf you are compiling Sass from the [command-line tool](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#using_sass), here are some options we recommend.\n\nIn development:\n\n    sass --style expanded --line-numbers --load-path [path to]/govuk_frontend_toolkit/stylesheets input.scss output.css\n\nIn production:\n\n    sass --style compressed --load-path [path to]/govuk_frontend_toolkit/stylesheets input.scss output.css\n\n## Documentation\n\n* [Mixin-sets](/docs/mixins.md)\n  * [Grid layout](/docs/mixins.md#grid-layout)\n  * [Conditionals](/docs/mixins.md#conditionals)\n  * [Colours](/docs/mixins.md#colours)\n  * [Typography](/docs/mixins.md#typography)\n  * [CSS3](/docs/mixins.md#css3)\n  * [Buttons](/docs/mixins.md#buttons)\n  * [Phase banner](/docs/mixins.md#-phase-banner)\n  * [Phase tags](/docs/mixins.md#-phase-tags)\n* [JavaScript](/docs/javascript.md)\n  * [Modules](/docs/javascript.md#modules)\n  * [Media player](/docs/javascript.md#media-player)\n  * [Primary links](/docs/javascript.md#primary-links)\n  * [Stick at top when scrolling](/docs/javascript.md#stick-at-top-when-scrolling)\n  * [Selection buttons](/docs/javascript.md#selection-buttons)\n  * [Shim links with button role](/docs/javascript.md#shim-links-with-button-role)\n  * [Show/Hide content](/docs/javascript.md#showhide-content)\n\n## Licence\n\nReleased under the MIT Licence, a copy of which can be found in the file `LICENCE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fgovuk_frontend_toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphagov%2Fgovuk_frontend_toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fgovuk_frontend_toolkit/lists"}