@workday/canvas-kit-docs 11.0.0-alpha.682-next.0 → 11.0.0-alpha.696-next.0

package/dist/mdx/preview-react/_examples/examples/Table/WithExpandableRows.tsx

@@ -0,0 +1,219 @@
+import React from 'react';
+
+import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
+import {Table} from '@workday/canvas-kit-preview-react/table';
+import {TertiaryButton} from '@workday/canvas-kit-react/button';
+import {createComponent, generateUniqueId} from '@workday/canvas-kit-react/common';
+import {Heading, Subtext} from '@workday/canvas-kit-react/text';
+import {Tooltip} from '@workday/canvas-kit-react/tooltip';
+import {createStyles} from '@workday/canvas-kit-styling';
+
+import {chevronDownSmallIcon, chevronRightSmallIcon} from '@workday/canvas-system-icons-web';
+import {system} from '@workday/canvas-tokens-web';
+
+interface AutoData {
+  id: string;
+  brand: string;
+  model: string;
+  year: string;
+  price: string;
+  engine: string;
+  transmission: string;
+  horsepower: string;
+  torque: string;
+  curbWeight: string;
+  orderStatus: string;
+}
+
+const headingID = generateUniqueId();
+const autoData: AutoData[] = [
+  {
+    id: generateUniqueId(),
+    brand: 'Porsche',
+    model: '992 911 GT3',
+    year: '2022',
+    price: 'Starts at $160,000',
+    engine: '4.0L Flat 6',
+    transmission: 'PDK or 7-Speed Manual',
+    horsepower: '502hp',
+    torque: '346 lb-ft',
+    curbWeight: '3,164 lbs',
+    orderStatus: 'Order Placed',
+  },
+  {
+    id: generateUniqueId(),
+    brand: 'BMW',
+    model: 'M5 Competition',
+    year: '2018',
+    price: 'Starts at $105,000',
+    engine: 'Twin-Turbo 4.4L V8',
+    transmission: 'Automatic',
+    horsepower: '627hp',
+    torque: '553 lb-ft',
+    curbWeight: '4,345 lbs',
+    orderStatus: 'Order Fulfilled',
+  },
+  {
+    id: generateUniqueId(),
+    brand: 'Audi',
+    model: 'R8',
+    year: '2022',
+    price: 'Starts at $148,000',
+    engine: '5.2L V10',
+    transmission: 'Automatic',
+    horsepower: '562hp',
+    torque: '408 lb-ft',
+    curbWeight: '3,594 lbs',
+    orderStatus: 'Order Fulfilled',
+  },
+  {
+    id: generateUniqueId(),
+    brand: 'Lotus',
+    model: 'Emira',
+    year: '2023',
+    price: 'Starts at $78,000',
+    engine: 'Supercharged 3.5L V6',
+    transmission: 'Automatic or 6-Speed Manual',
+    horsepower: '400hp',
+    torque: '317 lb-ft',
+    curbWeight: '3520 lbs',
+    orderStatus: 'Shipped: In Transit',
+  },
+  {
+    id: generateUniqueId(),
+    brand: 'Toyota',
+    model: 'Supra',
+    year: '1998',
+    price: '$40,000 - $80,000',
+    engine: '3.0L Inline 6',
+    transmission: 'Automatic or 6-Speed Manual',
+    horsepower: '320hp',
+    torque: '315 lb-ft',
+    curbWeight: '3,599 lbs',
+    orderStatus: 'Delivered',
+  },
+  {
+    id: generateUniqueId(),
+    brand: 'Nissan',
+    model: 'Skyline GT-R',
+    year: '1994',
+    price: '$45,000 - $90,000',
+    engine: '2.6L Twin-Turbo Inline 6',
+    transmission: '5-Speed Manual',
+    horsepower: '276hp',
+    torque: '260 lb-ft',
+    curbWeight: '3,153 lbs',
+    orderStatus: 'Delivered',
+  },
+];
+
+interface RowProps {
+  data: AutoData;
+}
+
+const expandableSectionStyles = createStyles({
+  alignItems: 'flex-start',
+  display: 'flex',
+  gap: system.space.x4,
+  padding: system.space.x8,
+});
+
+const expandableHeadingStyles = createStyles({
+  margin: 0,
+  fontWeight: system.fontWeight.bold,
+});
+
+const expandableListStyles = createStyles({
+  listStyle: 'none',
+  margin: 0,
+  padding: 0,
+  gap: system.space.x2,
+});
+
+function ExpandableRow({data}: RowProps) {
+  const [rowExpanded, setRowExpanded] = React.useState(false);
+
+  return (
+    <>
+      <Table.Row gridTemplateColumns="4rem repeat(4, 1fr)">
+        <Table.Cell>
+          <Tooltip title={`${data.brand} ${data.model}`}>
+            <TertiaryButton
+              size="small"
+              icon={rowExpanded ? chevronDownSmallIcon : chevronRightSmallIcon}
+              aria-expanded={rowExpanded}
+              onClick={() => setRowExpanded(!rowExpanded)}
+            />
+          </Tooltip>
+        </Table.Cell>
+        <Table.Header scope="row">{data.brand}</Table.Header>
+        <Table.Cell>{data.model}</Table.Cell>
+        <Table.Cell>{data.year}</Table.Cell>
+        <Table.Cell>{data.price}</Table.Cell>
+      </Table.Row>
+      {rowExpanded && (
+        <Table.Row>
+          <Table.Cell colSpan={5} cs={expandableSectionStyles}>
+            <div>
+              <Subtext as="h4" size="large" cs={expandableHeadingStyles}>
+                Status
+              </Subtext>
+              <StatusIndicator variant="blue">{data.orderStatus}</StatusIndicator>
+            </div>
+            <div>
+              <Subtext as="h4" size="large" cs={expandableHeadingStyles}>
+                Specifications
+              </Subtext>
+              <ul className={expandableListStyles}>
+                <Subtext as="li" size="large">
+                  Engine: {data.engine}
+                </Subtext>
+                <Subtext as="li" size="large">
+                  Transmission: {data.transmission}
+                </Subtext>
+                <Subtext as="li" size="large">
+                  Horsepower: {data.horsepower}
+                </Subtext>
+                <Subtext as="li" size="large">
+                  Torque: {data.torque}
+                </Subtext>
+                <Subtext as="li" size="large">
+                  Curb Weight: {data.curbWeight}
+                </Subtext>
+              </ul>
+            </div>
+          </Table.Cell>
+        </Table.Row>
+      )}
+    </>
+  );
+}
+
+export default createComponent()({
+  displayName: 'ExpandableRows',
+  Component: () => {
+    return (
+      <>
+        <Heading as="h3" id={headingID} size="small">
+          Showroom Inventory
+        </Heading>
+        <Table aria-labelledby={headingID}>
+          <Table.Head>
+            <Table.Row gridTemplateColumns="4rem repeat(4, 1fr)">
+              <Table.Cell></Table.Cell>
+              <Table.Header scope="col">Make</Table.Header>
+              <Table.Header scope="col">Model</Table.Header>
+              <Table.Header scope="col">Year</Table.Header>
+              <Table.Header scope="col">Price</Table.Header>
+            </Table.Row>
+          </Table.Head>
+          <Table.Body>
+            {autoData.map(item => (
+              <ExpandableRow key={item.id} data={item} />
+            ))}
+          </Table.Body>
+        </Table>
+      </>
+    );
+  },
+});

package/dist/mdx/preview-react/_examples/examples/Table/WithSelectableRows.tsx

@@ -0,0 +1,156 @@
+import React from 'react';
+
+import {Table} from '@workday/canvas-kit-preview-react/table';
+import {Heading} from '@workday/canvas-kit-react/text';
+import {Checkbox} from '@workday/canvas-kit-react/checkbox';
+import {createComponent, generateUniqueId} from '@workday/canvas-kit-react/common';
+import {Tooltip} from '@workday/canvas-kit-react/tooltip';
+import {createStencil, createStyles} from '@workday/canvas-kit-styling';
+import {base} from '@workday/canvas-tokens-web';
+
+const selectableRowStencil = createStencil({
+  base: {
+    gridTemplateColumns: '3.5rem repeat(2, 1fr)',
+    transition: 'background-color 200ms',
+  },
+  modifiers: {
+    isSelected: {
+      true: {
+        backgroundColor: base.blueberry100,
+      },
+    },
+  },
+});
+
+const tableHeaderStyles = createStyles({
+  backgroundColor: base.soap100,
+});
+
+const tableCellStyles = createStyles({
+  backgroundColor: 'transparent',
+});
+
+interface SelectableRowProps {
+  onSelect?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+  rowData: PizzaTopping;
+}
+
+const SelectableRow = createComponent('tr')({
+  displayName: 'SelectableRow',
+  Component: ({onSelect, rowData}: SelectableRowProps) => {
+    return (
+      <Table.Row cs={selectableRowStencil({isSelected: rowData.checked})}>
+        <Table.Cell cs={tableCellStyles}>
+          <Tooltip title={rowData.name}>
+            <Checkbox checked={rowData.checked} onChange={onSelect} />
+          </Tooltip>
+        </Table.Cell>
+        <Table.Cell cs={tableCellStyles} scope="row">
+          {rowData.name}
+        </Table.Cell>
+        <Table.Cell cs={tableCellStyles}>{rowData.amount}</Table.Cell>
+      </Table.Row>
+    );
+  },
+});
+
+interface PizzaTopping {
+  name: string;
+  amount: string;
+  checked: boolean;
+}
+
+const pizzaToppingData: PizzaTopping[] = [
+  {name: 'Pepperoni', amount: '2.5 oz.', checked: false},
+  {name: 'Mozzarella', amount: '5 oz.', checked: false},
+  {name: 'Basil', amount: '10 Leaves', checked: false},
+  {name: 'Roasted Red Peppers', amount: '3 oz.', checked: false},
+  {name: 'Mushrooms', amount: '2 oz.', checked: false},
+];
+
+const headingID = generateUniqueId();
+
+type SelectAll = 'checked' | 'indeterminate' | 'unchecked';
+
+export default () => {
+  const [selectAllState, setSelectAllState] = React.useState<SelectAll>('unchecked');
+  const [toppings, setToppings] = React.useState(pizzaToppingData);
+
+  const handleToppingChange = (name: string) => {
+    // Toggle the selected item's checked state and update state
+    const updatedToppings = toppings.map(topping => {
+      if (topping.name === name) {
+        return {...topping, checked: !topping.checked};
+      } else {
+        return topping;
+      }
+    });
+    setToppings(updatedToppings);
+
+    // Update the Select All checkbox state
+    const selectedToppings = updatedToppings.filter(topping => topping.checked === true);
+    // If no toppings are selected, set the Select All checkbox to 'unchecked'
+    if (selectedToppings.length === 0) {
+      setSelectAllState('unchecked');
+      // If all toppings are selected, set the Select All checkbox to 'checked'
+    } else if (selectedToppings.length === updatedToppings.length) {
+      setSelectAllState('checked');
+      // Otherwise, set the Select All checkbox to 'indeterminate'
+    } else {
+      setSelectAllState('indeterminate');
+    }
+  };
+
+  const handleSelectAll = () => {
+    // If the Select All checkbox is in a checked or indeterminate state,
+    // update it to 'unchecked', and uncheck all topping checkboxes
+    if (selectAllState === 'checked' || selectAllState === 'indeterminate') {
+      setSelectAllState('unchecked');
+      const updatedToppingData = toppings.map(topping => ({...topping, checked: false}));
+      setToppings(updatedToppingData);
+    }
+    // If the Select All checkbox is in an unchecked state,
+    // update it to 'checked', and check all topping checkboxes
+    if (selectAllState === 'unchecked') {
+      setSelectAllState('checked');
+      const updatedToppingData = toppings.map(topping => ({...topping, checked: true}));
+      setToppings(updatedToppingData);
+    }
+  };
+
+  return (
+    <>
+      <Heading as="h3" id={headingID} size="small">
+        Select your pizza toppings
+      </Heading>
+      <Table aria-labelledby={headingID}>
+        <Table.Row gridTemplateColumns="3.5rem repeat(2, 1fr)">
+          <Table.Cell cs={tableHeaderStyles}>
+            <Tooltip title="Select All">
+              <Checkbox
+                checked={selectAllState === 'checked'}
+                indeterminate={selectAllState === 'indeterminate'}
+                onChange={handleSelectAll}
+              />
+            </Tooltip>
+          </Table.Cell>
+          <Table.Header scope="col" cs={tableHeaderStyles}>
+            Toppings
+          </Table.Header>
+          <Table.Header scope="col" cs={tableHeaderStyles}>
+            Amount
+          </Table.Header>
+        </Table.Row>
+        <Table.Body>
+          {toppings.map(rowData => (
+            <SelectableRow
+              key={rowData.name}
+              rowData={rowData}
+              onSelect={() => handleToppingChange(rowData.name)}
+            />
+          ))}
+        </Table.Body>
+      </Table>
+    </>
+  );
+};

package/dist/mdx/preview-react/_examples/examples/Table/WithSortableColumnHeaders.tsx

@@ -0,0 +1,213 @@
+import React from 'react';
+
+import {createComponent} from '@workday/canvas-kit-react/common';
+import {Table} from '@workday/canvas-kit-preview-react/table';
+import {Tooltip} from '@workday/canvas-kit-react/tooltip';
+import {TertiaryButton} from '@workday/canvas-kit-react/button';
+import {Text} from '@workday/canvas-kit-react/text';
+import {sortDownIcon, sortUpIcon} from '@workday/canvas-system-icons-web';
+import {createStyles} from '@workday/canvas-kit-styling';
+import {system} from '@workday/canvas-tokens-web';
+
+interface CountryData {
+  country: string;
+  capital: string;
+  population: number;
+}
+
+const countryData: CountryData[] = [
+  {country: 'Australia', capital: 'Canberra', population: 25690000},
+  {country: 'Bahamas', capital: 'Nassau', population: 407906},
+  {country: 'Canada', capital: 'Ottawa', population: 38250000},
+  {country: 'Fiji', capital: 'Suva', population: 924610},
+  {country: 'Ghana', capital: 'Accra', population: 32830000},
+  {country: 'Hong Kong', capital: 'City of Victoria', population: 7413000},
+  {country: 'India', capital: 'New Delhi', population: 1408000000},
+  {country: 'Ireland', capital: 'Dublin', population: 5033000},
+  {country: 'Jamaica', capital: 'Kingston', population: 2828000},
+  {country: 'Kenya', capital: 'Nairobi', population: 53010000},
+  {country: 'Micronesia', capital: 'Palikir', population: 113131},
+  {country: 'New Zealand', capital: 'Wellington', population: 5123000},
+  {country: 'Philippines', capital: 'Manila', population: 113900000},
+  {country: 'Puerto Rico', capital: 'San Juan', population: 3264000},
+  {country: 'Samoa', capital: 'Apia', population: 218764},
+  {country: 'Singapore', capital: 'Singapore', population: 5454000},
+  {country: 'Tanzania', capital: 'Dodoma', population: 63590000},
+  {country: 'United Kingdom', capital: 'London', population: 67330000},
+  {country: 'United States', capital: 'Washington, D.C.', population: 331900000},
+  {country: 'Zimbabwe', capital: 'Harare', population: 15990000},
+];
+
+type SortOrder = 'ascending' | 'descending' | 'none';
+
+interface HeaderRowState {
+  column1SortDirection: SortOrder;
+  column2SortDirection: SortOrder;
+  column3SortDirection: SortOrder;
+}
+
+interface HeaderRowAction {
+  column: 'Country' | 'Capital' | 'Population';
+  payload: CountryData[];
+}
+
+const initialHeaderRowState: HeaderRowState = {
+  column1SortDirection: 'none',
+  column2SortDirection: 'none',
+  column3SortDirection: 'none',
+};
+
+/**
+ * Given the current sort order, return the next sort order
+ */
+function getNextSortOrder(sortOrder: SortOrder) {
+  return sortOrder === 'ascending' ? 'descending' : 'ascending';
+}
+
+function headerRowReducer(state: HeaderRowState, action: HeaderRowAction): HeaderRowState {
+  switch (action.column) {
+    case 'Country':
+      if (state.column1SortDirection === 'ascending') {
+        action.payload.sort((a, b) => b.country.localeCompare(a.country));
+      } else {
+        action.payload.sort((a, b) => a.country.localeCompare(b.country));
+      }
+
+      return {
+        ...initialHeaderRowState,
+        column1SortDirection: getNextSortOrder(state.column1SortDirection),
+      };
+
+    case 'Capital':
+      if (state.column2SortDirection === 'ascending') {
+        action.payload.sort((a, b) => b.capital.localeCompare(a.capital));
+      } else {
+        action.payload.sort((a, b) => a.capital.localeCompare(b.capital));
+      }
+
+      return {
+        ...initialHeaderRowState,
+        column2SortDirection: getNextSortOrder(state.column2SortDirection),
+      };
+
+    case 'Population':
+      if (state.column3SortDirection === 'ascending') {
+        action.payload.sort((a, b) => b.population - a.population);
+      } else {
+        action.payload.sort();
+      }
+
+      return {
+        ...initialHeaderRowState,
+        column3SortDirection: getNextSortOrder(state.column3SortDirection),
+      };
+
+    default:
+      return initialHeaderRowState;
+  }
+}
+
+interface SortableColumnHeaderProps {
+  label: string;
+  onSortAction: (label: string) => void;
+  children?: React.ReactNode;
+  sortOrder: SortOrder;
+}
+
+const getSortIcon = (sortOrder?: SortOrder) => {
+  if (sortOrder === 'ascending') {
+    return sortUpIcon;
+  } else if (sortOrder === 'descending') {
+    return sortDownIcon;
+  } else {
+    return undefined;
+  }
+};
+
+export default createComponent('th')({
+  displayName: 'SortableColumnHeader',
+  Component: (
+    {label, sortOrder, onSortAction, children, ...elemProps}: SortableColumnHeaderProps,
+    ref
+  ) => {
+    return (
+      <Table.Header ref={ref} scope="col" aria-sort={sortOrder} {...elemProps}>
+        <Tooltip type="describe" title={`Sort ${getNextSortOrder(sortOrder)}`}>
+          <TertiaryButton
+            icon={getSortIcon(sortOrder)}
+            iconPosition="end"
+            onClick={() => onSortAction(label)}
+          >
+            {children}
+          </TertiaryButton>
+        </Tooltip>
+      </Table.Header>
+    );
+  },
+});
+
+const textStyles = createStyles({
+  paddingInlineStart: system.space.x3,
+});
+
+export default () => {
+  const [headerRowState, headerRowDispatch] = React.useReducer(
+    headerRowReducer,
+    initialHeaderRowState
+  );
+
+  function sortColumnHandler(columnName) {
+    headerRowDispatch({
+      column: columnName,
+      payload: countryData,
+    });
+  }
+
+  return (
+    <Table maxHeight="40rem">
+      <Table.Caption>Population Listed by Country (2021)</Table.Caption>
+      <Table.Head>
+        <Table.Row>
+          <SortableColumnHeader
+            label="Country"
+            sortOrder={headerRowState.column1SortDirection as SortOrder}
+            onSortAction={sortColumnHandler}
+          >
+            Country
+          </SortableColumnHeader>
+          <SortableColumnHeader
+            label="Capital"
+            sortOrder={headerRowState.column2SortDirection as SortOrder}
+            onSortAction={sortColumnHandler}
+          >
+            Capital
+          </SortableColumnHeader>
+          <SortableColumnHeader
+            label="Population"
+            sortOrder={headerRowState.column3SortDirection as SortOrder}
+            onSortAction={sortColumnHandler}
+          >
+            Population
+          </SortableColumnHeader>
+        </Table.Row>
+      </Table.Head>
+      <Table.Body>
+        {countryData.map(item => {
+          return (
+            <Table.Row key={item.country}>
+              <Table.Header scope="row">
+                <Text cs={textStyles}>{item.country}</Text>
+              </Table.Header>
+              <Table.Cell>
+                <Text cs={textStyles}>{item.capital}</Text>
+              </Table.Cell>
+              <Table.Cell>
+                <Text cs={textStyles}>{item.population.toLocaleString()}</Text>
+              </Table.Cell>
+            </Table.Row>
+          );
+        })}
+      </Table.Body>
+    </Table>
+  );
+};

package/dist/mdx/preview-react/table/Table.mdx

@@ -1,9 +1,10 @@
-import {SymbolDoc, Specifications} from '@workday/canvas-kit-docs';
+import {SymbolDoc} from '@workday/canvas-kit-docs';
 import {Table} from '@workday/canvas-kit-preview-react/table';
 // Examples
 import Basic from './examples/Basic';
 import BasicWithHeading from './examples/BasicWithHeading';
 import FixedColumn from './examples/FixedColumn';
+import RightToLeft from './examples/RightToLeft';
 
 
 # Canvas Kit Table
@@ -29,6 +30,12 @@ customization of the title/heading of their table.
 
 <ExampleCodeBlock code={BasicWithHeading} />
 
+### Right to Left
+
+Table supports right-to-left languages when specified in the CanvasProvider theme.
+
+<ExampleCodeBlock code={RightToLeft} />
+
 ### Example with Caption
 
 Users are free to use a `caption` instead of a heading. A `caption` is not required but it is good
@@ -46,6 +53,14 @@ Users may add styles to the `Table.Header` to render a fixed column. The example
 
 <ExampleCodeBlock code={FixedColumn} />
 
+### Advanced
+
+You can also find several advanced Table examples in our Storybook Examples section.
+
+- [Expandable Rows](/docs/examples-tables-advanced--expandable-rows)
+- [Selectable Rows ](/docs/examples-tables-advanced--selectable-rows)
+- [Sortable Column Headers](/docs/examples-tables-advanced--sortable-column-headers)
+
 ## Component API
 
 <SymbolDoc name="Table" fileName="/preview-react/" />