Skip to content

Commit

Permalink
Move to govuk-react org (#479)
Browse files Browse the repository at this point in the history
e.g. for improved CI options
  • Loading branch information
penx committed Nov 24, 2018
1 parent 44c6eac commit 74d3012
Show file tree
Hide file tree
Showing 56 changed files with 60 additions and 60 deletions.
2 changes: 1 addition & 1 deletion API.md
Expand Up @@ -868,7 +868,7 @@ to build an accurate grid layout.
3. `Main` contains the required properties to center a container that matches up with `TopNav`
and house the remaining body of content for the page.
If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/UKHomeOffice/govuk-react/issues/177)
If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/govuk-react/govuk-react/issues/177)
### Usage
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -74,15 +74,15 @@ For the purpose of this project:
- A field is the combination of a label, input(s) and validation/error messages. The Field components used by this project should follow the prop structure of Final Form and Redux Form fields, in that they accept an `input` prop and a `meta` prop.
- An input is just the form control that the user enters data in to, without a label or error/validation message. Inputs are normally associated with a Field and should be used on their own by importing the Field then using `<FieldName.Input />`. Inputs follow the prop structure of Final Form and Redux Form inputs.

More details in https://github.com/UKHomeOffice/govuk-react/issues/164.
More details in https://github.com/govuk-react/govuk-react/issues/164.

### Anchors

We want to be router agnostic. We want to support parent projects using React Router or Reach Router, without introducing either as a dependency of this project. As such we provide an `as` prop on components that we expect can be used as React Router Links or NavLinks. We recommend using the [`asNavLink` HOC](https://www.npmjs.com/package/as-nav-link). More details in https://github.com/UKHomeOffice/govuk-react/issues/423.
We want to be router agnostic. We want to support parent projects using React Router or Reach Router, without introducing either as a dependency of this project. As such we provide an `as` prop on components that we expect can be used as React Router Links or NavLinks. We recommend using the [`asNavLink` HOC](https://www.npmjs.com/package/as-nav-link). More details in https://github.com/govuk-react/govuk-react/issues/423.


### White Space

Components are built to have no white space around them, and are then wrapped with the withWhiteSpace HOC where we can provide some default values. This allows the parent application to override the defaults with e.g. an `mb` prop.

More details in https://github.com/UKHomeOffice/govuk-react/issues/173
More details in https://github.com/govuk-react/govuk-react/issues/173
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -2,8 +2,8 @@

An implementation of the [GOV.UK Design System](https://govuk-design-system-production.cloudapps.digital) in [React](https://reactjs.org) using [CSSinJS](https://medium.com/seek-blog/a-unified-styling-language-d0c208de2660) using Object notation (with [Emotion](https://emotion.sh/docs/object-styles)).

[![Build Status](https://travis-ci.org/UKHomeOffice/govuk-react.svg?branch=master)](https://travis-ci.org/UKHomeOffice/govuk-react)
[![codecov](https://codecov.io/gh/UKHomeOffice/govuk-react/branch/master/graph/badge.svg)](https://codecov.io/gh/UKHomeOffice/govuk-react)
[![Build Status](https://travis-ci.org/govuk-react/govuk-react.svg?branch=master)](https://travis-ci.org/govuk-react/govuk-react)
[![codecov](https://codecov.io/gh/govuk-react/govuk-react/branch/master/graph/badge.svg)](https://codecov.io/gh/govuk-react/govuk-react)

The following projects (in priority order) are used as a guide for what components to implement and how they should look/behave. Where possible we are using the existing CSS as a guide, but often need to modify to suit custom markup. Also flexbox is preferred over floats.

Expand Down Expand Up @@ -81,7 +81,7 @@ We are also expecting to use [Interoperable Style Transfer Format (ISTF)](https:

## About the GDS font

Unfortuantely the GDS transport font has a relatively restrictive license [described on the gov.uk blog](https://designnotes.blog.gov.uk/2015/03/11/can-i-use-the-gov-uk-fonts/). We are investigating rendering an elegant alternative before falling back to Arial on [issue 272](https://github.com/UKHomeOffice/govuk-react/issues/272).
Unfortuantely the GDS transport font has a relatively restrictive license [described on the gov.uk blog](https://designnotes.blog.gov.uk/2015/03/11/can-i-use-the-gov-uk-fonts/). We are investigating rendering an elegant alternative before falling back to Arial on [issue 272](https://github.com/govuk-react/govuk-react/issues/272).

## Related sites and projects

Expand Down
2 changes: 1 addition & 1 deletion components/back-link/package.json
Expand Up @@ -25,7 +25,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/back-link",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/back-link",
"description": "Styled anchor with left-pointing triangle, children rendered as text and optional click handler.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/breadcrumb/package.json
Expand Up @@ -24,7 +24,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/breadcrumb",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/breadcrumb",
"description": "Renders a styled container, unordered list and list items containing links passed as children.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/button/package.json
Expand Up @@ -26,7 +26,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/button",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/button",
"description": "Styled button component with configurable properties.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/checkbox/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/checkbox",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/checkbox",
"description": "Styled checkbox component, also displaying label.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/date-field/package.json
Expand Up @@ -26,7 +26,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/date-field",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/date-field",
"description": "Date field component displaying day, month and year and featuring several configurable options.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/document-footer-metadata/package.json
Expand Up @@ -22,7 +22,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/document-footer-metadata",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/document-footer-metadata",
"description": "Renders styled document footer metadata from props provided.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/error-summary/package.json
Expand Up @@ -27,7 +27,7 @@
"module": "es/index.js",
"author": "Tarandeep Singh Chauhan",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/error-summary",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/error-summary",
"description": "Notice used to display form errors to user - also includes anchors to jump to relevant form sections.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/error-text/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/error-text",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/error-text",
"description": "Renders a styled span element containing children provided.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/file-upload/package.json
Expand Up @@ -25,7 +25,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/file-upload",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/file-upload",
"description": "File input component with label expected as children.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/grid-col/package.json
Expand Up @@ -20,7 +20,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/grid-col",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/grid-col",
"description": "GridCol component for use inside GridRow component - includes media query breakpoints.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/grid-row/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/grid-row",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/grid-row",
"description": "GridRow component for use around GridCol components - includes media query breakpoints.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/header/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/header",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/header",
"description": "Outputs a styled heading tag of provided level, rendering children as contents.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/hidden-text/package.json
Expand Up @@ -23,7 +23,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/hidden-text",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/hidden-text",
"description": "Renders a styled details element along with summary from prop and children rendered as contents.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/hint-text/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/hint-text",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/hint-text",
"description": "Renders a styled span element with children provided.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/input-field/package.json
Expand Up @@ -26,7 +26,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/input-field",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/input-field",
"description": "Styled composite component displaying an input with a label and hint text and error text depending on props.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/input/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/input",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/input",
"description": "Styled input component with optional type prop, defaulting to 'text'.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/inset-text/package.json
Expand Up @@ -22,7 +22,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/inset-text",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/inset-text",
"description": "Renders a styled div containing children with a left hand border, wide or narrow depending on prop passed.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/label-text/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/label-text",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/label-text",
"description": "Styled span element with children displayed as text.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/label/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/label",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/label",
"description": "Styled label with children displayed as text.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/layout/README.md
Expand Up @@ -16,7 +16,7 @@ to build an accurate grid layout.
3. `Main` contains the required properties to center a container that matches up with `TopNav`
and house the remaining body of content for the page.

If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/UKHomeOffice/govuk-react/issues/177)
If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/govuk-react/govuk-react/issues/177)

### Usage

Expand Down
2 changes: 1 addition & 1 deletion components/layout/package.json
Expand Up @@ -20,7 +20,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/layout",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/layout",
"description": "Component intended to surround grid layouts but now no longer used/required.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/layout/src/index.js
Expand Up @@ -19,7 +19,7 @@ const StyledLayout = styled('div')({
* 3. `Main` contains the required properties to center a container that matches up with `TopNav`
* and house the remaining body of content for the page.
*
* If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/UKHomeOffice/govuk-react/issues/177)
* If you feel you may still need a `Layout` component, please do raise a ticket on [Github](https://github.com/govuk-react/govuk-react/issues/177)
*
* ### Usage
*
Expand Down
2 changes: 1 addition & 1 deletion components/lead-paragraph/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/lead-paragraph",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/lead-paragraph",
"description": "Renders children passed inside a styled paragraph element.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/list-item/package.json
Expand Up @@ -25,7 +25,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/list-item",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/list-item",
"description": "Renders a styled list item containing children passed.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/list-navigation/package.json
Expand Up @@ -26,7 +26,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/list-navigation",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/list-navigation",
"description": "Renders ListItems in an UnorderedList from children sent, with optional list style type.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/loading-box/package.json
Expand Up @@ -27,7 +27,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/loading-box",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/loading-box",
"description": "Absolutely positioned loading overlay with spinner and numerous configurable options.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/main/package.json
Expand Up @@ -23,7 +23,7 @@
"module": "es/index.js",
"author": "Toby Brancher",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/main",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/main",
"description": "Styled container which aligns to topNav component, is centered, and provides top padding.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/multi-choice/package.json
Expand Up @@ -24,7 +24,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/multi-choice",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/multi-choice",
"description": "Styled container for a group of radio buttons (the children), also accepting label, meta and hint props.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/ordered-list/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/ordered-list",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/ordered-list",
"description": "Renders an ordered list containing children passed - also supports listStyleType prop.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/pagination/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/pagination",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/pagination",
"description": "Renders a styled list using flexbox, along with PaginationAnchor items expected to be provided as children.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/panel/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/panel",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/panel",
"description": "Styled panel accepting a heading string and an array of body text as strings or mark-up.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/paragraph/package.json
Expand Up @@ -25,7 +25,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/paragraph",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/paragraph",
"description": "Renders a styled paragraph around children, also supporting and styling sub-elements from markdown and accepting several optional props.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/phase-badge/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/phase-badge",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/phase-badge",
"description": "Badge with solid background and bold text, rendered from children.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/phase-banner/package.json
Expand Up @@ -22,7 +22,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/phase-banner",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/phase-banner",
"description": "Banner with solid background and bold text, rendered from children.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/radio/package.json
Expand Up @@ -21,7 +21,7 @@
"module": "es/index.js",
"author": "Alasdair McLeay",
"license": "MIT",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/radio",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/radio",
"description": "Styled radio button with several configurable props.",
"private": false,
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion components/related-items/package.json
Expand Up @@ -25,6 +25,6 @@
"main": "lib/index.js",
"module": "es/index.js",
"author": "Alasdair McLeay",
"homepage": "https://github.com/UKHomeOffice/govuk-react/tree/master/components/related-items",
"homepage": "https://github.com/govuk-react/govuk-react/tree/master/components/related-items",
"description": "Container which expects to receive a heading and list and styles them accordingly."
}

0 comments on commit 74d3012

Please sign in to comment.