Skip to content

Commit

Permalink
Update refs to old Source packages (#1482)
Browse files Browse the repository at this point in the history
  • Loading branch information
sndrs committed May 23, 2024
1 parent 30f9458 commit 7cad92c
Show file tree
Hide file tree
Showing 85 changed files with 172 additions and 231 deletions.
5 changes: 2 additions & 3 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@

/.changeset/ @guardian/client-side-infra @guardian/dotcom-platform @guardian/commercial-dev @guardian/identity @guardian/source @guardian/transparency-consent

/libs/@guardian/source-foundations/ @guardian/client-side-infra @guardian/source
/libs/@guardian/source-react-components/ @guardian/client-side-infra @guardian/source
/libs/@guardian/source-react-components-development-kitchen/ @guardian/client-side-infra @guardian/source
/libs/@guardian/source/ @guardian/client-side-infra @guardian/source
/libs/@guardian/source-development-kitchen/ @guardian/client-side-infra @guardian/source

/libs/@guardian/browserlist-config/ @guardian/client-side-infra @guardian/dotcom-platform

Expand Down
7 changes: 3 additions & 4 deletions docs/source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@

## Source packages ⚛️

There are three main Source packages:
There are two main Source packages:

- [`@guardian/source-foundations`](../../libs/@guardian/source-foundations/README.md): The atoms from which all our visual design is built. They may be used with any CSS-in-JS library
- [`@guardian/source-react-components`](../../libs/@guardian/source-react-components/README.md): A set of robust, accessible React components built using @guardian/source-foundations
- [`@guardian/source-react-components-development-kitchen`](../../libs/@guardian/source-react-components-development-kitchen/README.md): The Development Kitchen is where new components and patterns can be cooked up, tested and shared. There are minimal acceptance criteria. It’s okay to duplicate and break things. If a Kitchen component proves valuable, it may be promoted to `@guardian/source-react-components`
- [`@guardian/source`](../../libs/@guardian/source/README.md): Contains `foundations` (the atoms from which all our visual design is built and which may be used with any CSS-in-JS library), and `react-components` (a set of robust, accessible React components built using `foundations`).
- [`@guardian/source-development-kitchen`](../../libs/@guardian/source-development-kitchen/README.md): The Development Kitchen is where new components and patterns can be cooked up, tested and shared. There are minimal acceptance criteria. It’s okay to duplicate and break things. If a Kitchen component proves valuable, it may be promoted to `@guardian/source`

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $ make build-storybook

### Creating new components

- New components should be added to the [Development Kitchen](https://github.com/guardian/csnx/tree/main/libs/%40guardian/source-react-components-development-kitchen).
- New components should be added to the [Development Kitchen](https://github.com/guardian/csnx/tree/main/libs/%40guardian/source-development-kitchen).
- New components must have a CODEOWNER.

### Using Emotion
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Inserts a yellow warning banner on the page showing how old the content is
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_agewarning--age-warning)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-agewarning--age-warning)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Inserts a line on the page acting as a section break dividing content
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_divider--default-divider)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-divider--default-divider)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ export interface EditorialButtonProps
SharedEditorialButtonProps {}

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_editorialbutton--when-primary) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-editorialbutton--when-primary) •
* [Design System](https://theguardian.design/2a1e5182b/p/435225-button) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/editorial-button/EditorialButton.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/editorial-button/EditorialButton.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*
* This is the editorial version of the core Button component.
* This editorial version requires the format prop and uses that to override Button styles based on `format.theme`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ export interface EditorialLinkButtonProps
SharedEditorialButtonProps {}

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_editoriallinkbutton--when-primary) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-editoriallinkbutton--when-primary) •
* [Design System](https://theguardian.design/2a1e5182b/p/435225-button) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/editorial-button/EditorialLinkButton.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/editorial-button/EditorialLinkButton.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*
* This is the editorial version of the core Button component.
* This editorial version requires the format prop and uses that to override Button styles based on `format.theme`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ Also exported is `EditorialLinkButton` which, like in core, offers a href versio
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_editorialbutton--when-primary)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-editorialbutton--when-primary)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import { ExpandingWrapper } from './ExpandingWrapper';
import { expandingWrapperDarkTheme } from './theme';

/**
* [Storybook](https://guardian.github.io/csnx/?path=/story/source-react-components-development-kitchen_expandingwrapper--expanding-wrapper)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/expanding-wrapper/ExpandingWrapper.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components)
* [Storybook](https://guardian.github.io/csnx/?path=/story/source-development-kitchen_expandingwrapper--expanding-wrapper)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/expanding-wrapper/ExpandingWrapper.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source)
*
* An Expanding Wrapper surrounds a bit of content that can be collapsed and expanded
* Note: When collapsed, there should be no focusable elements within the wrapper.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ The Expanding Wrapper wraps around any children, and collapses the block so it t
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use
Expand All @@ -20,7 +20,7 @@ $ npm i @guardian/source-react-components-development-kitchen

#### `ExpandingWrapper`

See [storybook](https://guardian.github.io/csnx/?path=/story/source-react-components-development-kitchen_expandingwrapper--expanding-wrapper)
See [storybook](https://guardian.github.io/csnx/?path=/story/source-development-kitchen_expandingwrapper--expanding-wrapper)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import type { Meta, StoryFn } from '@storybook/react';
import { FileInput } from './FileInput';

/**
* [Storybook](https://guardian.github.io/csnx/?path=/story/source-react-components-development-kitchen_fileinput--optional-file-input&globals=backgrounds.value:transparent)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/file-input)
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [Storybook](https://guardian.github.io/csnx/?path=/story/source-development-kitchen_fileinput--optional-file-input&globals=backgrounds.value:transparent)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/file-input)
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*
* An input for files
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ The File Input is a styled input for files. If it is mandatory, the file may be
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use
Expand All @@ -20,7 +20,7 @@ $ npm i @guardian/source-react-components-development-kitchen

#### `FileInput`

See [storybook](https://guardian.github.io/csnx/?path=/story/source-react-components-development-kitchen_fileinput--file-input)
See [storybook](https://guardian.github.io/csnx/?path=/story/source-development-kitchen_fileinput--file-input)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ A footer component that can have content added inside of it, and a footer links
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use
Expand All @@ -24,7 +24,7 @@ A `FooterLink` object can be used if you want to include an anchor tag with an h

If your site uses the Guardian CMP `@guardian/consent-management-platform`, you should include a `FooterButton` object in the `links` prop with an `onClick` callback that launches the CMP and the text "Privacy Settings".

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_divider--default-divider) for examples.
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-divider--default-divider) for examples.

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ export interface LinesProps {
}

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_lines--default-lines) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-lines--default-lines) •
* [Design System](https://theguardian.design) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/lines/Lines.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/lines/Lines.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*
* @deprecated prefer using the right line type component directly:
* - `StraightLines`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_lines--default-lines)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-lines--default-lines)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,10 @@ const logoStyles = css`
`;

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_logo--desktop) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-logo--desktop) •
* [Design System](https://theguardian.design) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/logo/Logo.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/logo/Logo.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*/
export const Logo = ({ logoType = 'standard', cssOverrides }: LogoProps) => (
<a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ The Guardian logo appears in the header on most editorial pages
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_logo--desktop)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-logo--desktop)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ export type NumericInputProps = Omit<TextInputProps, 'inputmode'> & {
};

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_numericinput--default-default-theme) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-numericinput--default-default-theme) •
* [Design System](https://theguardian.design/2a1e5182b/p/097455-text-input-field/b/050445) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/numeric-input/NumericInput.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/numeric-input/NumericInput.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/@guardian/source-development-kitchen)
*
* This is an iteration on the core TextInput component for taking numeric input, such as currency amounts.
* It can optionally display a prefix and/or suffix to add additonal visual context.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ A component for taking numeric input such as currency. Can display a prefix and/
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_numericinput--default-default-theme)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-numericinput--default-default-theme)

### How to use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ export type QuoteIconProps = {
};

/**
* [Storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_quoteicon--news) •
* [Storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-quoteicon--news) •
* [Design System](https://theguardian.design) •
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-react-components-development-kitchen/src/quote-icon/QuoteIcon.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-react-components-development-kitchen)
* [GitHub](https://github.com/guardian/csnx/tree/main/libs/@guardian/source-development-kitchen/src/quote-icon/QuoteIcon.tsx) •
* [NPM](https://www.npmjs.com/package/@guardian/source-development-kitchen)
*
* The Guardian quote icon is used in kickers, headlines, drop caps and pull quotes to denote quoted text.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ The Guardian quote icon is used in kickers, headlines, drop caps and pull quotes
## Install

```sh
$ yarn add @guardian/source-react-components-development-kitchen
$ pnpm add @guardian/source-development-kitchen
```

or

```sh
$ npm i @guardian/source-react-components-development-kitchen
$ npm i @guardian/source-development-kitchen
```

## Use

### API

See [storybook](https://guardian.github.io/csnx/?path=/docs/source-react-components-development-kitchen_quoteicon--news)
See [storybook](https://guardian.github.io/storybooks/?path=/story/source-development-kitchen_react-components-quoteicon--news)

### How to use

Expand Down
Loading

0 comments on commit 7cad92c

Please sign in to comment.