Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Storybook] Add stories for more components (leftovers) #7797

Merged
merged 10 commits into from
Jun 4, 2024
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
299 changes: 299 additions & 0 deletions packages/eui/src/components/basic_table/basic_table.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
/*
mgadewoll marked this conversation as resolved.
Show resolved Hide resolved
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

import React, { useCallback, useEffect, useState } from 'react';
import type { Meta, StoryObj } from '@storybook/react';
import { action } from '@storybook/addon-actions';
import { faker } from '@faker-js/faker';
import { moveStorybookControlsToCategory } from '../../../.storybook/utils';

import { EuiLink } from '../link';
import { EuiHealth } from '../health';

import type {
CriteriaWithPagination,
EuiBasicTableColumn,
} from './basic_table';
import { EuiBasicTable, EuiBasicTableProps } from './basic_table';

// Set static seed so that the generated faker data is consistent between page loads
faker.seed(8_02_2010);

const meta: Meta<EuiBasicTableProps<User>> = {
title: 'Tabular Content/EuiBasicTable',
// @ts-ignore complex
component: EuiBasicTable,
argTypes: {
noItemsMessage: { control: 'text' },
},
args: {
error: '',
loading: false,
// Inherited from EuiTable
responsiveBreakpoint: 'm',
tableLayout: 'fixed',
// set up for easier testing/QA
cellProps: {
'data-test-subj': `basic-table-cell`,
},
rowProps: {
'data-test-subj': `basic-table-row`,
},
noItemsMessage: '',
},
};
moveStorybookControlsToCategory(
meta,
['responsiveBreakpoint', 'tableLayout'],
'EuiTable props'
);

export default meta;
type Story = StoryObj<EuiBasicTableProps<User>>;

type User = {
id: number;
firstName: string | null | undefined;
lastName: string;
online: boolean;
location: {
city: string;
country: string;
};
};

const users: User[] = [];

for (let i = 0; i < 5; i++) {
users.push({
id: i + 1,
firstName: faker.person.firstName(),
lastName: faker.person.lastName(),
online: faker.datatype.boolean(),
location: {
city: faker.location.city(),
country: faker.location.country(),
},
});
}

const columns: Array<EuiBasicTableColumn<User>> = [
{
field: 'firstName',
name: 'First Name',
sortable: true,
truncateText: true,
mobileOptions: {
render: (user: User) => (
<span>
{user.firstName} {user.lastName}
</span>
),
header: false,
truncateText: false,
enlarge: true,
width: '100%',
},
},
{
field: 'lastName',
name: 'Last Name',
truncateText: true,
sortable: true,
mobileOptions: {
show: false,
},
},
{
field: 'location',
name: 'Location',
truncateText: true,
textOnly: true,
render: (location: User['location']) => {
return `${location.city}, ${location.country}`;
},
},
{
field: 'online',
name: 'Online',
dataType: 'boolean',
render: (online: User['online']) => {
const color = online ? 'success' : 'danger';
const label = online ? 'Online' : 'Offline';
return <EuiHealth color={color}>{label}</EuiHealth>;
},
sortable: true,
mobileOptions: {
show: false,
},
},
{
name: 'Actions',
actions: [
{
name: 'User profile',
description: ({ firstName, lastName }) =>
`Visit ${firstName} ${lastName}'s profile`,
icon: 'editorLink',
color: 'primary',
type: 'icon',
enabled: ({ online }) => !!online,
href: ({ id }) => `${window.location.href}?id=${id}`,
target: '_self',
'data-test-subj': 'action-outboundlink',
},
{
name: <>Clone</>,
description: 'Clone this user',
icon: 'copy',
type: 'icon',
onClick: () => {},
'data-test-subj': 'action-clone',
},
{
name: (user: User) => (user.id ? 'Delete' : 'Remove'),
description: ({ firstName, lastName }) =>
`Delete ${firstName} ${lastName}`,
icon: 'trash',
color: 'danger',
type: 'icon',
onClick: () => {},
isPrimary: true,
'data-test-subj': ({ id }) => `action-delete-${id}`,
},
{
name: 'Edit',
isPrimary: true,
available: ({ online }) => !online,
enabled: ({ online }) => !!online,
description: 'Edit this user',
icon: 'pencil',
type: 'icon',
onClick: () => {},
'data-test-subj': 'action-edit',
},
{
name: 'Share',
isPrimary: true,
description: 'Share this user',
icon: 'share',
type: 'icon',
onClick: () => {},
'data-test-subj': 'action-share',
},
],
},
{
name: 'Custom actions',
actions: [
{
render: () => (
<EuiLink onClick={() => {}} color="danger">
Delete
</EuiLink>
),
showOnHover: true,
},
{
render: () => <EuiLink onClick={() => {}}>Edit</EuiLink>,
},
],
},
];

const initialPageSize = 3;

export const Playground: Story = {
args: {
tableCaption: 'EuiBasicTable playground',
items: users,
itemId: 'id',
rowHeader: 'firstName',
columns,
itemIdToExpandedRowMap: {},
pagination: {
pageIndex: 0,
totalItemCount: 5,
pageSize: initialPageSize,
pageSizeOptions: [3, 5],
},
sorting: {
sort: {
field: 'lastName',
direction: 'asc' as const,
},
},
selection: {
selectable: (user) => user.online,
selectableMessage: (selectable) =>
!selectable ? 'User is currently offline' : '',
onSelectionChange: action('onSelectionChange'),
},
onChange: (criteria: CriteriaWithPagination<User>) =>
action('onChange')(criteria),
},
render: (args: EuiBasicTableProps<User>) => <StatefulPlayground {...args} />,
};

export const ExpandedRow: Story = {
parameters: {
controls: {
include: ['columns', 'items', 'itemIdToExpandedRowMap'],
},
},
args: {
tableCaption: 'EuiBasicTable playground',
items: users,
itemId: 'id',
rowHeader: 'firstName',
columns,
itemIdToExpandedRowMap: {
1: (
<div>
<strong>Expanded row 1</strong>
<p>lorem ipsum dolor sit</p>
</div>
),
},
},
};

const StatefulPlayground = ({
items,
pagination,
sorting,
...rest
}: EuiBasicTableProps<User>) => {
const [_items, setItems] = useState<User[]>([]);

const updateItems = useCallback(() => {
let sortedItems = [...items];

if (sorting?.sort) {
const { field, direction } = sorting?.sort;
const directionIndex = direction === 'desc' ? -1 : 1;

sortedItems = sortedItems.sort((a, b) =>
a[field]! > b[field]! ? directionIndex : -directionIndex
);
}

setItems(() => {
return [...sortedItems].splice(
0,
pagination?.pageSize ?? initialPageSize
);
});
}, [items, pagination, sorting]);

useEffect(() => {
updateItems();
}, [items, pagination, sorting, updateItems]);

return <EuiBasicTable items={_items} pagination={pagination!} {...rest} />;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/

import type { Meta, StoryObj } from '@storybook/react';

import { enableFunctionToggleControls } from '../../../../.storybook/utils';
import { REFRESH_UNIT_OPTIONS } from '../types';

import { EuiAutoRefresh, EuiAutoRefreshProps } from './auto_refresh';

const meta: Meta<EuiAutoRefreshProps> = {
title: 'Forms/EuiAutoRefresh/EuiAutoRefresh',
component: EuiAutoRefresh,
parameters: {
loki: {
// TODO: uncomment once loki CLI is fixed for portal component stories
// chromeSelector: LOKI_SELECTORS.portal,
},
},
argTypes: {
intervalUnits: {
control: 'radio',
options: [undefined, ...REFRESH_UNIT_OPTIONS],
},
},
args: {
isPaused: true,
refreshInterval: 1000,
minInterval: 0,
readOnly: true,
isDisabled: false,
},
};
enableFunctionToggleControls(meta, ['onRefreshChange']);

export default meta;
type Story = StoryObj<EuiAutoRefreshProps>;

export const Playground: Story = {
// TODO: uncomment once loki CLI is fixed for portal component stories
// play: lokiPlayDecorator(async (context) => {
// const { bodyElement, step } = context;
// const canvas = within(bodyElement);
// await step('show popover on click of the input', async () => {
// await userEvent.click(canvas.getByLabelText('Auto refresh'));
// await waitFor(() => {
// expect(canvas.getByRole('dialog')).toBeVisible();
// });
// });
// }),
};
Loading
Loading