GithubHelp home page GithubHelp logo

techpunk316 / govuk-frontend Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alphagov/govuk-frontend

0.0 1.0 0.0 4.96 MB

This project is in Alpha. Not for production use.

License: MIT License

JavaScript 5.18% CSS 81.72% HTML 13.02% Shell 0.07%

govuk-frontend's Introduction

GOV.UK Frontend ยท Build Status JavaScript Style Guide

What is it?

A single package containing everything needed to start building a GOV.UK service.

๐Ÿšจ This project is in development and these instructions are likely to change. ๐Ÿšจ

Guidance for building a GOV.UK service - [GOV.UK Design System](TODO: Insert link to GOV.UK Design System).

Quick start

๐Ÿšจ This will not work until packages are published to npm. ๐Ÿšจ

npm install --save @govuk-frontend/all

Include the CSS and JavaScript

<!DOCTYPE html>
<html>
  <head>
    <title>Example</title>
    <link rel="stylesheet"
          href="node_modules/@govuk-frontend/all/all.min.css">
  </head>
  <body>
    <!-- Copy and paste component HTML-->
    <button class="govuk-c-button">This is a button component</button>
    <script src="node_modules/@govuk-frontend/all/all.min.js"></script>
  </body>
</html>

Installation

Install all components

npm install --save @govuk-frontend/all

Install individual components

Install a button component

npm install --save @govuk-frontend/button

All components can be found in the packages directory. Each component has a README with installation and usage instructions.

Usage

HTML

Copy and paste component HTML [from here](TODO: Insert link to GOV.UK Design System).

SCSS

In your main.scss file

// All components
@import "@govuk-frontend/all/all";

// Pick and choose components
@import "@govuk-frontend/button/button";
@import "@govuk-frontend/input/input"

Docs

Check out the GOV.UK Frontend documentation.

Licence

MIT license.

Contributing

View our contribution guidelines.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.