-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1344 from dequelabs/release-v6.2.0
chore(cauldron): Release 6.2.0
- Loading branch information
Showing
46 changed files
with
2,826 additions
and
2,896 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
module.exports = { | ||
root: true, | ||
parser: '@typescript-eslint/parser', | ||
parserOptions: { | ||
project: 'tsconfig.json', | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: Timeline | ||
description: A list component to display a list of events or items in chronological order. | ||
source: https://github.com/dequelabs/cauldron/tree/develop/packages/react/src/components/Timeline/Timeline.tsx | ||
--- | ||
|
||
import { Timeline, TimelineItem, Icon } from '@deque/cauldron-react' | ||
|
||
```js | ||
import { Timeline, TimelineItem } from '@deque/cauldron-react' | ||
``` | ||
|
||
## Examples | ||
|
||
### Default | ||
|
||
```jsx example | ||
<Timeline> | ||
<TimelineItem> | ||
<strong>Wake Up</strong> | ||
<div>8am</div> | ||
</TimelineItem> | ||
<TimelineItem> | ||
<strong>Eat Breakfast</strong> | ||
<div>8:30am</div> | ||
<div>Avocado Toast</div> | ||
</TimelineItem> | ||
<TimelineItem> | ||
<strong>Work</strong> | ||
<div>9am</div> | ||
</TimelineItem> | ||
<TimelineItem> | ||
<strong>Lunch</strong> | ||
<div>11:30am</div> | ||
<div>BLT</div> | ||
</TimelineItem> | ||
<TimelineItem> | ||
<strong>Dinner</strong> | ||
<div>5:30pm</div> | ||
<div>Vegetable Stir Fry</div> | ||
</TimelineItem> | ||
<TimelineItem> | ||
<strong>Sleep</strong> | ||
<div>11pm</div> | ||
</TimelineItem> | ||
</Timeline> | ||
``` | ||
|
||
### Custom Icon | ||
|
||
```jsx example | ||
<Timeline> | ||
<TimelineItem icon={<Icon type="arrow-circle-down" />}>Item with custom icon</TimelineItem> | ||
<TimelineItem>Item with default mark</TimelineItem> | ||
<TimelineItem>Item with default mark</TimelineItem> | ||
<TimelineItem icon={<Icon type="check-solid" />}>Item with custom icon</TimelineItem> | ||
</Timeline> | ||
``` | ||
|
||
## Props | ||
|
||
### Timeline | ||
|
||
<ComponentProps | ||
className={true} | ||
children={true} | ||
/> | ||
|
||
### TimelineItem | ||
|
||
<ComponentProps | ||
className={true} | ||
children={true} | ||
props={[{ | ||
name: 'icon', | ||
type: 'React.ReactElement', | ||
description: 'Optional element to display as icon instead of the default mark' | ||
}]} | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
module.exports = { | ||
extends: ['../../.eslintrc.js', 'plugin:ssr-friendly/recommended'], | ||
plugins: ['ssr-friendly'], | ||
overrides: [ | ||
{ | ||
files: ['__tests__/**/*', '**/*.test.[j|t]sx?'], | ||
rules: { | ||
'ssr-friendly/no-dom-globals-in-module-scope': 'off', | ||
'ssr-friendly/no-dom-globals-in-constructor': 'off', | ||
'ssr-friendly/no-dom-globals-in-react-cc-render': 'off', | ||
'ssr-friendly/no-dom-globals-in-react-fc': 'off' | ||
} | ||
} | ||
] | ||
}; |
Oops, something went wrong.