✨⏰🥶 storybook-mock-date-decorator 🥶⏰✨

Install

For Storybook 9.0+

1npm i storybook-mock-date-decorator@3 -D

For Storybook 6, 7, or 8

1npm i storybook-mock-date-decorator@2 -D

Note: If you're using Storybook 6, 7, or 8, you must use the /legacy import path. Please refer to the v2.x README for complete usage instructions.

API

Once the decorator has been added to your storybook, you can configure the date with the parameter name date inside your stories.

Usage

Storybook 9

1import { mockDateDecorator } from "storybook-mock-date-decorator";
2
3/** @type { import('@storybook/react').Preview } */
4const preview = {
5  decorators: [mockDateDecorator],
6  parameters: {
7    controls: {
8      matchers: {
9        color: /(background|color)$/i,
10      },
11    },
12  },
13};
14
15export default preview;

1// stories/Button.stories.js
2
3export default {
4  title: 'Example/Button',
5  component: Button,
6  parameters: {
7    date: new Date(1999, 10, 24),
8  },
9};
10
11export const Primary = {
12  args: {
13    primary: true,
14    label: 'Button',
15  },
16  parameters: {
17    date: new Date(2021, 1, 1),
18  }
19};

Story Examples

Then inside your storybook, you can use the following code to mock/freeze the date for all stories of a component:

1import { Meta } from "@storybook/react"
2import { YourComponent } from "./your-component"
3
4export default {
5	title: "YourComponent",
6	component: YourComponent,
7	parameters: {
8		date: new Date("March 10, 2021 10:00:00"),
9	},
10} as Meta
11

Or you can mock/freeze the date for a specific story:

1import { Meta } from "@storybook/react"
2import { YourComponent } from "./your-component"
3
4export default {
5	title: "YourComponent",
6	component: YourComponent,
7} as Meta
8
9export function Default() {
10    return <div>hello world at {new Date().toLocaleString()}</div>
11}
12
13export function WithMockedDate() {
14    return <div>hello world! with mocked date of March 10th at {new Date().toLocaleString()}</div>
15}
16WithMockedDate.parameters = {
17    date: new Date("March 10, 2021 10:00:00"),
18}
19

Version Compatibility

Storybook Version	Package Version	Import Path	Documentation
9.0+	@3	storybook-mock-date-decorator	This README
8.x	@2	storybook-mock-date-decorator/legacy	v2.x README
6.x, 7.x	@2	storybook-mock-date-decorator/legacy	v2.x README

Important: For Storybook 6, 7, and 8, you must use the /legacy import path and follow the setup instructions in the v2.x documentation.