Skip to content

Commit

Permalink
Merge pull request #344 from WestpacGEL/343-no-demo-components-in-bre…
Browse files Browse the repository at this point in the history
…adcrumbs-in-gel-next

fixes #343 breadcrumbs example
  • Loading branch information
jaortiz authored Nov 23, 2023
2 parents 6826908 + 6455d15 commit 6eb8d26
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Use alerts to draw attention to specific messages in a particular context. They
#### Alert types

**Success:** The green message colour and tick icon is used to communicate successful completion of a process or task. It is commonly used with confirmation messaging, the intention is to provide confidence that a process has been completed successfully and the user can now move on.

**Information:** The blue message colour and info icon is used to convey useful information. It should be used for things like instructions, feedback about information that has been provided, or high-level information about a system or process. This style provides flexibility to use a different icon. To remain accessible, do not use any of the default icons that are used for the other alert types.

**Warning:** The orange message colour and warning icon is for use in scenarios where the user needs to understand something before proceeding. It is saved for necessary messaging but not for error messages. For example, ‘this process will time-out in 3 min’ - use it as a ‘Watch out’, rather than a stop.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,47 @@
```jsx
// Using the Link component (as NextLink) from 'next/LinkLink'
<Breadcrumb>
<NextLink href="#test" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Another anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isDisabled tag="a">
Disabled item
</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">
Last item
</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
<div className="flex flex-col gap-5">
<Breadcrumb aria-label="Page transitions and the such">
<NextLink href="#home" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">Home</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
<Breadcrumb aria-label="Page transitions and the such">
<NextLink href="#home" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Home</Breadcrumb.Item>
</NextLink>
<NextLink href="#personal" passHref legacyBehavior>
<Breadcrumb.Item tag="a" isCurrent>Personal</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
<Breadcrumb aria-label="Page transitions and the such">
<NextLink href="#home" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Home</Breadcrumb.Item>
</NextLink>
<NextLink href="#personal" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Personal</Breadcrumb.Item>
</NextLink>
<NextLink href="#credit-cards" passHref legacyBehavior>
<Breadcrumb.Item tag="a" isCurrent>Credit cards</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
<Breadcrumb>
<NextLink href="#test" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Another anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isDisabled tag="a">
Disabled item
</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">
Last item
</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
</div>
```
60 changes: 41 additions & 19 deletions apps/site/src/content/design-system/components/breadcrumb/code.mdoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,45 @@
## Breadcrumb
### Default breadcrumb

```jsx
// Using the Link component (as NextLink) from 'next/LinkLink'
<Breadcrumb>
<NextLink href="#test" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Another anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isDisabled tag="a">
Disabled item
</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">
Last item
</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
<div>
<Breadcrumb>
<NextLink href="#test" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Another anchor item</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isDisabled tag="a">
Disabled item
</Breadcrumb.Item>
</NextLink>
<NextLink href="#another" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">
Last item
</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
</div>
```

### As router

```jsx
<div>
<Breadcrumb aria-label="Page transitions and the such">
<NextLink href="#home" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Home</Breadcrumb.Item>
</NextLink>
<NextLink href="#personal" passHref legacyBehavior>
<Breadcrumb.Item tag="a">Personal</Breadcrumb.Item>
</NextLink>
<NextLink href="#credit-cards" passHref legacyBehavior>
<Breadcrumb.Item isCurrent tag="a">
Credit cards
</Breadcrumb.Item>
</NextLink>
</Breadcrumb>
</div>
```

0 comments on commit 6eb8d26

Please sign in to comment.