@ndlib/component-library 0.0.7-9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -0
- package/dist/FontLoader.d.ts +1 -0
- package/dist/FontLoader.js +4 -0
- package/dist/components/composites/Card/Card.stories.d.ts +13 -0
- package/dist/components/composites/Card/Card.stories.js +122 -0
- package/dist/components/composites/Card/Card.test.d.ts +1 -0
- package/dist/components/composites/Card/Card.test.js +37 -0
- package/dist/components/composites/Card/index.d.ts +36 -0
- package/dist/components/composites/Card/index.js +89 -0
- package/dist/components/composites/DragDropList/DragDropList.stories.d.ts +7 -0
- package/dist/components/composites/DragDropList/DragDropList.stories.js +32 -0
- package/dist/components/composites/DragDropList/index.d.ts +25 -0
- package/dist/components/composites/DragDropList/index.js +48 -0
- package/dist/components/composites/DropdownLinks/DropdownLinks.stories.d.ts +8 -0
- package/dist/components/composites/DropdownLinks/DropdownLinks.stories.js +25 -0
- package/dist/components/composites/DropdownLinks/DropdownLinks.test.d.ts +1 -0
- package/dist/components/composites/DropdownLinks/DropdownLinks.test.js +27 -0
- package/dist/components/composites/DropdownLinks/index.d.ts +15 -0
- package/dist/components/composites/DropdownLinks/index.js +28 -0
- package/dist/components/composites/EmptyState/EmptyState.stories.d.ts +10 -0
- package/dist/components/composites/EmptyState/EmptyState.stories.js +31 -0
- package/dist/components/composites/EmptyState/EmptyState.test.d.ts +1 -0
- package/dist/components/composites/EmptyState/EmptyState.test.js +20 -0
- package/dist/components/composites/EmptyState/index.d.ts +15 -0
- package/dist/components/composites/EmptyState/index.js +32 -0
- package/dist/components/composites/Modal/Modal.stories.d.ts +6 -0
- package/dist/components/composites/Modal/Modal.stories.js +40 -0
- package/dist/components/composites/Modal/index.d.ts +21 -0
- package/dist/components/composites/Modal/index.js +64 -0
- package/dist/components/composites/NavMenu/NavMenu.stories.d.ts +6 -0
- package/dist/components/composites/NavMenu/NavMenu.stories.js +12 -0
- package/dist/components/composites/NavMenu/NavMenu.test.d.ts +1 -0
- package/dist/components/composites/NavMenu/NavMenu.test.js +96 -0
- package/dist/components/composites/NavMenu/demo.d.ts +1 -0
- package/dist/components/composites/NavMenu/demo.js +172 -0
- package/dist/components/composites/NavMenu/index.d.ts +5 -0
- package/dist/components/composites/NavMenu/index.js +52 -0
- package/dist/components/composites/Seo/SeoDataDisplay/index.d.ts +2 -0
- package/dist/components/composites/Seo/SeoDataDisplay/index.js +9 -0
- package/dist/components/composites/Seo/index.d.ts +11 -0
- package/dist/components/composites/Seo/index.js +16 -0
- package/dist/components/composites/Seo/seo.stories.d.ts +6 -0
- package/dist/components/composites/Seo/seo.stories.js +12 -0
- package/dist/components/composites/Seo/seo.test.d.ts +1 -0
- package/dist/components/composites/Seo/seo.test.js +56 -0
- package/dist/components/composites/Seo/siteMetadata.d.ts +9 -0
- package/dist/components/composites/Seo/siteMetadata.js +16 -0
- package/dist/components/composites/SnackBar/SnackBar.stories.d.ts +8 -0
- package/dist/components/composites/SnackBar/SnackBar.stories.js +20 -0
- package/dist/components/composites/SnackBar/SnackBar.test.d.ts +1 -0
- package/dist/components/composites/SnackBar/SnackBar.test.js +75 -0
- package/dist/components/composites/SnackBar/examples.d.ts +3 -0
- package/dist/components/composites/SnackBar/examples.js +35 -0
- package/dist/components/composites/SnackBar/index.d.ts +1 -0
- package/dist/components/composites/SnackBar/index.js +45 -0
- package/dist/components/composites/StructuredData/StructuredData.stories.d.ts +6 -0
- package/dist/components/composites/StructuredData/StructuredData.stories.js +12 -0
- package/dist/components/composites/StructuredData/StructuredData.test.d.ts +1 -0
- package/dist/components/composites/StructuredData/StructuredData.test.js +48 -0
- package/dist/components/composites/StructuredData/StructuredDataDisplay/index.d.ts +2 -0
- package/dist/components/composites/StructuredData/StructuredDataDisplay/index.js +37 -0
- package/dist/components/composites/StructuredData/index.d.ts +38 -0
- package/dist/components/composites/StructuredData/index.js +58 -0
- package/dist/components/composites/StructuredData/sdEvent/index.d.ts +13 -0
- package/dist/components/composites/StructuredData/sdEvent/index.js +16 -0
- package/dist/components/composites/StructuredData/sdEvent/makeEventSchema.d.ts +15 -0
- package/dist/components/composites/StructuredData/sdEvent/makeEventSchema.js +16 -0
- package/dist/components/composites/StructuredData/sdNews/index.d.ts +11 -0
- package/dist/components/composites/StructuredData/sdNews/index.js +14 -0
- package/dist/components/composites/StructuredData/sdNews/makeNewsSchema.d.ts +12 -0
- package/dist/components/composites/StructuredData/sdNews/makeNewsSchema.js +11 -0
- package/dist/components/composites/StructuredData/sdWebsite/index.d.ts +8 -0
- package/dist/components/composites/StructuredData/sdWebsite/index.js +11 -0
- package/dist/components/composites/StructuredData/sdWebsite/makeWebPageSchema.d.ts +9 -0
- package/dist/components/composites/StructuredData/sdWebsite/makeWebPageSchema.js +9 -0
- package/dist/components/composites/StructuredData/siteMetadata.d.ts +9 -0
- package/dist/components/composites/StructuredData/siteMetadata.js +12 -0
- package/dist/components/elements/Alerts/Alert.stories.d.ts +9 -0
- package/dist/components/elements/Alerts/Alert.stories.js +41 -0
- package/dist/components/elements/Alerts/Alerts.stories.d.ts +6 -0
- package/dist/components/elements/Alerts/Alerts.stories.js +12 -0
- package/dist/components/elements/Alerts/Alerts.test.d.ts +1 -0
- package/dist/components/elements/Alerts/Alerts.test.js +61 -0
- package/dist/components/elements/Alerts/index.d.ts +14 -0
- package/dist/components/elements/Alerts/index.js +64 -0
- package/dist/components/elements/ArrowLink/ArrowLink.stories.d.ts +6 -0
- package/dist/components/elements/ArrowLink/ArrowLink.stories.js +12 -0
- package/dist/components/elements/ArrowLink/ArrowLink.test.d.ts +1 -0
- package/dist/components/elements/ArrowLink/ArrowLink.test.js +34 -0
- package/dist/components/elements/ArrowLink/index.d.ts +7 -0
- package/dist/components/elements/ArrowLink/index.js +39 -0
- package/dist/components/elements/BrandingBar/BrandingBar.stories.d.ts +6 -0
- package/dist/components/elements/BrandingBar/BrandingBar.stories.js +11 -0
- package/dist/components/elements/BrandingBar/index.d.ts +2 -0
- package/dist/components/elements/BrandingBar/index.js +52 -0
- package/dist/components/elements/Button/Button.stories.d.ts +15 -0
- package/dist/components/elements/Button/Button.stories.js +88 -0
- package/dist/components/elements/Button/Button.test.d.ts +1 -0
- package/dist/components/elements/Button/Button.test.js +39 -0
- package/dist/components/elements/Button/index.d.ts +49 -0
- package/dist/components/elements/Button/index.js +138 -0
- package/dist/components/elements/Dropdown/Dropdown.stories.d.ts +7 -0
- package/dist/components/elements/Dropdown/Dropdown.stories.js +20 -0
- package/dist/components/elements/Dropdown/index.d.ts +24 -0
- package/dist/components/elements/Dropdown/index.js +87 -0
- package/dist/components/elements/Fields/AutoComplete/AutoComplete.stories.d.ts +6 -0
- package/dist/components/elements/Fields/AutoComplete/AutoComplete.stories.js +60 -0
- package/dist/components/elements/Fields/AutoComplete/index.d.ts +11 -0
- package/dist/components/elements/Fields/AutoComplete/index.js +26 -0
- package/dist/components/elements/Fields/Checkbox/Checkbox.stories.d.ts +6 -0
- package/dist/components/elements/Fields/Checkbox/Checkbox.stories.js +17 -0
- package/dist/components/elements/Fields/Checkbox/index.d.ts +8 -0
- package/dist/components/elements/Fields/Checkbox/index.js +22 -0
- package/dist/components/elements/Fields/CheckboxGroup/CheckboxGroup.stories.d.ts +7 -0
- package/dist/components/elements/Fields/CheckboxGroup/CheckboxGroup.stories.js +26 -0
- package/dist/components/elements/Fields/CheckboxGroup/index.d.ts +16 -0
- package/dist/components/elements/Fields/CheckboxGroup/index.js +49 -0
- package/dist/components/elements/Fields/DatePicker/DatePicker.stories.d.ts +8 -0
- package/dist/components/elements/Fields/DatePicker/DatePicker.stories.js +31 -0
- package/dist/components/elements/Fields/DatePicker/index.d.ts +20 -0
- package/dist/components/elements/Fields/DatePicker/index.js +48 -0
- package/dist/components/elements/Fields/MonthPicker/MonthPicker.stories.d.ts +7 -0
- package/dist/components/elements/Fields/MonthPicker/MonthPicker.stories.js +20 -0
- package/dist/components/elements/Fields/MonthPicker/index.d.ts +13 -0
- package/dist/components/elements/Fields/MonthPicker/index.js +24 -0
- package/dist/components/elements/Fields/Radio/Radio.stories.d.ts +6 -0
- package/dist/components/elements/Fields/Radio/Radio.stories.js +17 -0
- package/dist/components/elements/Fields/Radio/index.d.ts +8 -0
- package/dist/components/elements/Fields/Radio/index.js +22 -0
- package/dist/components/elements/Fields/RadioGroup/RadioGroup.stories.d.ts +6 -0
- package/dist/components/elements/Fields/RadioGroup/RadioGroup.stories.js +23 -0
- package/dist/components/elements/Fields/RadioGroup/index.d.ts +14 -0
- package/dist/components/elements/Fields/RadioGroup/index.js +28 -0
- package/dist/components/elements/Fields/Select/Select.stories.d.ts +8 -0
- package/dist/components/elements/Fields/Select/Select.stories.js +39 -0
- package/dist/components/elements/Fields/Select/index.d.ts +18 -0
- package/dist/components/elements/Fields/Select/index.js +178 -0
- package/dist/components/elements/Fields/TextInput/TextInput.stories.d.ts +9 -0
- package/dist/components/elements/Fields/TextInput/TextInput.stories.js +35 -0
- package/dist/components/elements/Fields/TextInput/index.d.ts +45 -0
- package/dist/components/elements/Fields/TextInput/index.js +119 -0
- package/dist/components/elements/Fields/option.d.ts +16 -0
- package/dist/components/elements/Fields/option.js +3 -0
- package/dist/components/elements/Group/index.d.ts +22 -0
- package/dist/components/elements/Group/index.js +69 -0
- package/dist/components/elements/Icon/Icon.stories.d.ts +7 -0
- package/dist/components/elements/Icon/Icon.stories.js +29 -0
- package/dist/components/elements/Icon/Icon.test.d.ts +1 -0
- package/dist/components/elements/Icon/Icon.test.js +26 -0
- package/dist/components/elements/Icon/index.d.ts +10 -0
- package/dist/components/elements/Icon/index.js +34 -0
- package/dist/components/elements/Link/Link.stories.d.ts +6 -0
- package/dist/components/elements/Link/Link.stories.js +21 -0
- package/dist/components/elements/Link/Link.test.d.ts +1 -0
- package/dist/components/elements/Link/Link.test.js +58 -0
- package/dist/components/elements/Link/index.d.ts +14 -0
- package/dist/components/elements/Link/index.js +41 -0
- package/dist/components/elements/List/List.stories.d.ts +10 -0
- package/dist/components/elements/List/List.stories.js +37 -0
- package/dist/components/elements/List/List.test.d.ts +1 -0
- package/dist/components/elements/List/List.test.js +24 -0
- package/dist/components/elements/List/index.d.ts +27 -0
- package/dist/components/elements/List/index.js +103 -0
- package/dist/components/elements/ListBox/Listbox.stories.d.ts +6 -0
- package/dist/components/elements/ListBox/Listbox.stories.js +17 -0
- package/dist/components/elements/ListBox/index.d.ts +33 -0
- package/dist/components/elements/ListBox/index.js +51 -0
- package/dist/components/elements/Markdown/Markdown.stories.d.ts +10 -0
- package/dist/components/elements/Markdown/Markdown.stories.js +97 -0
- package/dist/components/elements/Markdown/Markdown.test.d.ts +1 -0
- package/dist/components/elements/Markdown/Markdown.test.js +91 -0
- package/dist/components/elements/Markdown/index.d.ts +21 -0
- package/dist/components/elements/Markdown/index.js +75 -0
- package/dist/components/elements/Pill/Pill.stories.d.ts +8 -0
- package/dist/components/elements/Pill/Pill.stories.js +40 -0
- package/dist/components/elements/Pill/Pill.test.d.ts +1 -0
- package/dist/components/elements/Pill/Pill.test.js +18 -0
- package/dist/components/elements/Pill/index.d.ts +21 -0
- package/dist/components/elements/Pill/index.js +117 -0
- package/dist/components/elements/Spinner/Spinner.stories.d.ts +7 -0
- package/dist/components/elements/Spinner/Spinner.stories.js +26 -0
- package/dist/components/elements/Spinner/Spinner.test.d.ts +1 -0
- package/dist/components/elements/Spinner/Spinner.test.js +9 -0
- package/dist/components/elements/Spinner/index.d.ts +14 -0
- package/dist/components/elements/Spinner/index.js +49 -0
- package/dist/components/elements/TabList/TabList.stories.d.ts +6 -0
- package/dist/components/elements/TabList/TabList.stories.js +12 -0
- package/dist/components/elements/TabList/TabList.test.d.ts +1 -0
- package/dist/components/elements/TabList/TabList.test.js +19 -0
- package/dist/components/elements/TabList/example.d.ts +7 -0
- package/dist/components/elements/TabList/example.js +36 -0
- package/dist/components/elements/TabList/index.d.ts +10 -0
- package/dist/components/elements/TabList/index.js +30 -0
- package/dist/components/elements/Table/Table.stories.d.ts +10 -0
- package/dist/components/elements/Table/Table.stories.js +96 -0
- package/dist/components/elements/Table/Table.test.d.ts +1 -0
- package/dist/components/elements/Table/Table.test.js +36 -0
- package/dist/components/elements/Table/index.d.ts +30 -0
- package/dist/components/elements/Table/index.js +100 -0
- package/dist/components/elements/layout/Box.d.ts +9 -0
- package/dist/components/elements/layout/Box.js +3 -0
- package/dist/components/elements/layout/Box.stories.d.ts +6 -0
- package/dist/components/elements/layout/Box.stories.js +12 -0
- package/dist/components/elements/layout/Column.d.ts +8 -0
- package/dist/components/elements/layout/Column.js +19 -0
- package/dist/components/elements/layout/Flex.stories.d.ts +10 -0
- package/dist/components/elements/layout/Flex.stories.js +26 -0
- package/dist/components/elements/layout/Flex.test.d.ts +1 -0
- package/dist/components/elements/layout/Flex.test.js +34 -0
- package/dist/components/elements/layout/Row.d.ts +20 -0
- package/dist/components/elements/layout/Row.js +52 -0
- package/dist/components/elements/text/Heading/Heading.stories.d.ts +8 -0
- package/dist/components/elements/text/Heading/Heading.stories.js +35 -0
- package/dist/components/elements/text/Heading/Heading.test.d.ts +1 -0
- package/dist/components/elements/text/Heading/Heading.test.js +51 -0
- package/dist/components/elements/text/Heading/index.d.ts +20 -0
- package/dist/components/elements/text/Heading/index.js +62 -0
- package/dist/components/elements/text/Inline/Inline.stories.d.ts +6 -0
- package/dist/components/elements/text/Inline/Inline.stories.js +12 -0
- package/dist/components/elements/text/Inline/index.d.ts +6 -0
- package/dist/components/elements/text/Inline/index.js +21 -0
- package/dist/components/elements/text/Label/Label.stories.d.ts +6 -0
- package/dist/components/elements/text/Label/Label.stories.js +20 -0
- package/dist/components/elements/text/Label/Label.test.d.ts +1 -0
- package/dist/components/elements/text/Label/Label.test.js +56 -0
- package/dist/components/elements/text/Label/index.d.ts +20 -0
- package/dist/components/elements/text/Label/index.js +38 -0
- package/dist/components/elements/text/Paragraph/Paragraph.stories.d.ts +6 -0
- package/dist/components/elements/text/Paragraph/Paragraph.stories.js +25 -0
- package/dist/components/elements/text/Paragraph/Paragraph.test.d.ts +1 -0
- package/dist/components/elements/text/Paragraph/Paragraph.test.js +9 -0
- package/dist/components/elements/text/Paragraph/index.d.ts +14 -0
- package/dist/components/elements/text/Paragraph/index.js +29 -0
- package/dist/components/elements/text/ReadMore/ReadMore.stories.d.ts +8 -0
- package/dist/components/elements/text/ReadMore/ReadMore.stories.js +26 -0
- package/dist/components/elements/text/ReadMore/index.d.ts +12 -0
- package/dist/components/elements/text/ReadMore/index.js +71 -0
- package/dist/components/providers/alerts.d.ts +41 -0
- package/dist/components/providers/alerts.js +133 -0
- package/dist/components/providers/componentConfig.d.ts +25 -0
- package/dist/components/providers/componentConfig.js +37 -0
- package/dist/components/providers/dialogs.d.ts +9 -0
- package/dist/components/providers/dialogs.js +32 -0
- package/dist/components/providers/env.d.ts +14 -0
- package/dist/components/providers/env.js +25 -0
- package/dist/components/providers/media.d.ts +8 -0
- package/dist/components/providers/media.js +43 -0
- package/dist/components/providers/menu.d.ts +46 -0
- package/dist/components/providers/menu.js +304 -0
- package/dist/components/providers/snackBar.d.ts +23 -0
- package/dist/components/providers/snackBar.js +53 -0
- package/dist/components/providers/ui.d.ts +18 -0
- package/dist/components/providers/ui.js +16 -0
- package/dist/components/providers/uniqueIds.d.ts +3 -0
- package/dist/components/providers/uniqueIds.js +23 -0
- package/dist/components/providers/uniqueIds.test.d.ts +1 -0
- package/dist/components/providers/uniqueIds.test.js +26 -0
- package/dist/index.d.ts +53 -0
- package/dist/index.js +51 -0
- package/dist/theme/Color.stories.d.ts +5 -0
- package/dist/theme/Color.stories.js +63 -0
- package/dist/theme/GlobalStyles.d.ts +1 -0
- package/dist/theme/GlobalStyles.js +167 -0
- package/dist/theme/Typography.stories.d.ts +5 -0
- package/dist/theme/Typography.stories.js +44 -0
- package/dist/theme/colors.d.ts +51 -0
- package/dist/theme/colors.js +97 -0
- package/dist/theme/custom.d.ts +11 -0
- package/dist/theme/custom.js +13 -0
- package/dist/theme/index.d.ts +185 -0
- package/dist/theme/index.js +25 -0
- package/dist/theme/spacing.d.ts +0 -0
- package/dist/theme/spacing.js +1 -0
- package/dist/theme/typography.d.ts +100 -0
- package/dist/theme/typography.js +206 -0
- package/dist/utils/hooks/useCheckMidClick.d.ts +8 -0
- package/dist/utils/hooks/useCheckMidClick.js +17 -0
- package/dist/utils/hooks/useCheckMidKeyPress.d.ts +9 -0
- package/dist/utils/hooks/useCheckMidKeyPress.js +23 -0
- package/dist/utils/hooks/useHover.d.ts +7 -0
- package/dist/utils/hooks/useHover.js +12 -0
- package/dist/utils/hooks/useStorage.d.ts +14 -0
- package/dist/utils/hooks/useStorage.js +37 -0
- package/dist/utils/misc.d.ts +14 -0
- package/dist/utils/misc.js +19 -0
- package/dist/utils/sortByKey.d.ts +12 -0
- package/dist/utils/sortByKey.js +20 -0
- package/dist/utils/test.d.ts +2 -0
- package/dist/utils/test.js +9 -0
- package/package.json +98 -0
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Hesburgh Component Library
|
|
2
|
+
|
|
3
|
+
This is the repo for The Hesburgh Component Library, a set of React components that escapsulate the
|
|
4
|
+
design patterns used by the Hesburgh Library IT department.
|
|
5
|
+
|
|
6
|
+
## Using the library
|
|
7
|
+
### Installation
|
|
8
|
+
To install the library in your project, run
|
|
9
|
+
```
|
|
10
|
+
yarn install @ndlib/component-library
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### Setup
|
|
14
|
+
|
|
15
|
+
#### UiProvider
|
|
16
|
+
In order for styles to be applied correctly, the `UiProvider` component must be included at the top of your project.
|
|
17
|
+
|
|
18
|
+
```tsx
|
|
19
|
+
<UiProvider>
|
|
20
|
+
<App>
|
|
21
|
+
</UiProvider>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
For frameworks that split application code by pages, it is recommended to add this provider at the root level rather than
|
|
25
|
+
at the page level. In Gatsby, this can be done using the [wrapRootElement](https://www.gatsbyjs.com/docs/reference/config-files/gatsby-browser/#wrapRootElement) browser API.
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
exports.wrapRootElement = ({ element }) => {
|
|
29
|
+
return (
|
|
30
|
+
<UiProvider>
|
|
31
|
+
{element}
|
|
32
|
+
</UiProvider>
|
|
33
|
+
)
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
#### Configuring Link
|
|
38
|
+
By default, the `Link` component in this library will use a native HTML `<a>` component in its implementation. This behavior can be overriden
|
|
39
|
+
by setting the `link.internalLink` and/or `link.externalLink` property on the `components` prop of the `UiProvider` component. If a custom component
|
|
40
|
+
is provided, the custom component will be rendered by when the <Link /> component is used. It will receive the same props the <Link> receives, as well as an
|
|
41
|
+
`sx` object with default link styles from the theme and any custom styles provided.
|
|
42
|
+
|
|
43
|
+
Note that the `theme-ui` jsx transform is needed in order to convert the `sx` prop into a stylesheet definition.
|
|
44
|
+
|
|
45
|
+
```tsx
|
|
46
|
+
/** @jsxImportSource theme-ui */
|
|
47
|
+
import { Link } from 'gatsby'
|
|
48
|
+
|
|
49
|
+
const CustomInternalLink = ({ sx, ...rest}) => ()
|
|
50
|
+
return <Link sx={sx} {...rest} />
|
|
51
|
+
)
|
|
52
|
+
|
|
53
|
+
const WrappedApp = () => {
|
|
54
|
+
<UiProvider components={{
|
|
55
|
+
link: {
|
|
56
|
+
internalLink: CustomInternalLink
|
|
57
|
+
}
|
|
58
|
+
}}>
|
|
59
|
+
<App />
|
|
60
|
+
</UiProvider>
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Running locally
|
|
65
|
+
Dependencies must be installed before storybook can be started. Dependencies can be installed with: `yarn install`.
|
|
66
|
+
|
|
67
|
+
To build and deploy your storybook locally for development, run `yarn start`
|
|
68
|
+
|
|
69
|
+
## Deploying Storybook
|
|
70
|
+
Whenever a commit is added to the main branch, the contents of the `/docs` folder will be deployed to our Github pages site.
|
|
71
|
+
|
|
72
|
+
To build a new version of the storybook to be deployed, run `yarn build-storybook`. Our storybook build uses [vite](https://vitejs.dev/).
|
|
73
|
+
|
|
74
|
+
## Running tests
|
|
75
|
+
Tests are run using [vitest](https://vitest.dev/), a test-runner built for vite that is similar to jest. Test suite can be run with: `yarn test`
|
|
76
|
+
|
|
77
|
+
## Linting
|
|
78
|
+
Changes should be linted before commits. Run our linter with `yarn lint`. Failed linting will block builds and deploys. Our lint process uses `eslint` and `prettier`.
|
|
79
|
+
Running `yarn lint:fix` will fix any issues that can be automatically fixed.
|
|
80
|
+
|
|
81
|
+
## Building for npm
|
|
82
|
+
The build process for the npm module for this library uses `tsc`. ESM exports are used to better support tree-shaking. When adding new code to this library,
|
|
83
|
+
be careful to ensure than importing the module do not cause side-effects. In other words, don't execute any process or do any state management outside
|
|
84
|
+
of exported properties or functions because this code might be removed by tree-shaker. See examples below:
|
|
85
|
+
|
|
86
|
+
### Wrong
|
|
87
|
+
```jsx
|
|
88
|
+
// This code may get removed by tree-shaker
|
|
89
|
+
setTimeout(() => {
|
|
90
|
+
console.log('hello world')
|
|
91
|
+
})
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Right
|
|
95
|
+
```jsx
|
|
96
|
+
export const myFunction = () => {
|
|
97
|
+
setTimeout(() => {
|
|
98
|
+
console.log('hello world')
|
|
99
|
+
})
|
|
100
|
+
}
|
|
101
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const FontLoader: () => import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from '@storybook/react';
|
|
2
|
+
import { Card } from '.';
|
|
3
|
+
declare const meta: Meta<typeof Card>;
|
|
4
|
+
export default meta;
|
|
5
|
+
type Story = StoryObj<typeof Card>;
|
|
6
|
+
export declare const Default: Story;
|
|
7
|
+
export declare const TruncateHeadline: Story;
|
|
8
|
+
export declare const Horizontal: Story;
|
|
9
|
+
export declare const DateCards: Story;
|
|
10
|
+
export declare const Clickable: Story;
|
|
11
|
+
export declare const Raised: Story;
|
|
12
|
+
export declare const Heading: Story;
|
|
13
|
+
export declare const CustomImageHeading: Story;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { createElement as _createElement } from "react";
|
|
2
|
+
import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
|
|
3
|
+
import AccessTime from '@mui/icons-material/AccessTimeFilled';
|
|
4
|
+
import CalendarIcon from '@mui/icons-material/CalendarMonth';
|
|
5
|
+
import BookmarkIcon from '@mui/icons-material/Bookmark';
|
|
6
|
+
import { CARD_LAYOUT, CARD_SIZE, Card } from '.';
|
|
7
|
+
import { COLOR, Column, LABEL_SIZE, Label, Paragraph, ReadMore, TYPOGRAPHY_TYPE, } from '../../..';
|
|
8
|
+
import { Icon } from '../../elements/Icon';
|
|
9
|
+
import { BUTTON_TYPE, Button } from '../../elements/Button';
|
|
10
|
+
const meta = {
|
|
11
|
+
title: 'Composites/Card',
|
|
12
|
+
component: Card,
|
|
13
|
+
tags: ['autodocs'],
|
|
14
|
+
};
|
|
15
|
+
export default meta;
|
|
16
|
+
const headlinedCards = [
|
|
17
|
+
{
|
|
18
|
+
headline: 'Exhibit — Printing the Nation: A Century of Irish Book Arts',
|
|
19
|
+
image: 'https://images.ctfassets.net/cfblb1f7i85j/7aCd5Sm86JdtQepGBKDUfy/dcb4d97dd3a1d3ee810e8bcaa82dc715/Spring_Exhibit_2023-Rep.jpg?w=296',
|
|
20
|
+
size: CARD_SIZE.SM,
|
|
21
|
+
sx: {
|
|
22
|
+
width: '500px',
|
|
23
|
+
},
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
headline: 'One Book, One Michiana Digital Exhibit — Papers Alight: Contextualizing Mike Curato’s Flamer. Other text to make this longer than the other card.',
|
|
27
|
+
image: 'https://images.ctfassets.net/cfblb1f7i85j/2sGpdDbNkl6MPnlem6wq1R/995c786624613b5ff07228e481996385/One.Book.2023-Rep.png?w=296',
|
|
28
|
+
size: CARD_SIZE.SM,
|
|
29
|
+
sx: {
|
|
30
|
+
width: '500px',
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
];
|
|
34
|
+
const basicCards = [
|
|
35
|
+
{
|
|
36
|
+
children: _jsx(Paragraph, { children: "Basic card 1" }),
|
|
37
|
+
size: CARD_SIZE.SM,
|
|
38
|
+
sx: {
|
|
39
|
+
width: '500px',
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
children: _jsx(Paragraph, { children: "Basic card 2" }),
|
|
44
|
+
size: CARD_SIZE.SM,
|
|
45
|
+
sx: {
|
|
46
|
+
width: '500px',
|
|
47
|
+
},
|
|
48
|
+
},
|
|
49
|
+
];
|
|
50
|
+
const dateCards = [
|
|
51
|
+
{
|
|
52
|
+
displayDate: new Date().toISOString(),
|
|
53
|
+
headline: 'Exhibit — Printing the Nation: A Century of Irish Book Arts',
|
|
54
|
+
size: CARD_SIZE.SM,
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
displayDate: new Date().toISOString(),
|
|
58
|
+
headline: 'One Book, One Michiana Digital Exhibit — Papers Alight: Contextualizing Mike Curato’s Flamer',
|
|
59
|
+
size: CARD_SIZE.SM,
|
|
60
|
+
},
|
|
61
|
+
];
|
|
62
|
+
const horizontalCards = [
|
|
63
|
+
{
|
|
64
|
+
headline: 'Exhibit — Printing the Nation: A Century of Irish Book Arts',
|
|
65
|
+
image: 'https://images.ctfassets.net/cfblb1f7i85j/7aCd5Sm86JdtQepGBKDUfy/dcb4d97dd3a1d3ee810e8bcaa82dc715/Spring_Exhibit_2023-Rep.jpg?w=296',
|
|
66
|
+
size: CARD_SIZE.SM,
|
|
67
|
+
children: (_jsxs(_Fragment, { children: [_jsxs(Label, Object.assign({ color: COLOR.PRIMARY, size: LABEL_SIZE.SM, sx: {
|
|
68
|
+
display: 'flex',
|
|
69
|
+
} }, { children: [_jsx(Icon, { icon: CalendarIcon, sx: { mr: 1 } }), "Monday, February 6 \u2013 Monday, July 31, 2023"] })), _jsxs(Label, Object.assign({ color: COLOR.PRIMARY, size: LABEL_SIZE.SM, sx: {
|
|
70
|
+
display: 'flex',
|
|
71
|
+
} }, { children: [_jsx(Icon, { icon: AccessTime, sx: { mr: 1 } }), "M-F: 9:30am \u2013 4:30pm"] })), _jsx(Paragraph, { children: "This exhibit demonstrates the art and craft of the Irish book since 1900." })] })),
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
headline: 'One Book, One Michiana Digital Exhibit — Papers Alight: Contextualizing Mike Curato’s Flamer',
|
|
75
|
+
image: 'https://images.ctfassets.net/cfblb1f7i85j/2sGpdDbNkl6MPnlem6wq1R/995c786624613b5ff07228e481996385/One.Book.2023-Rep.png?w=296',
|
|
76
|
+
size: CARD_SIZE.SM,
|
|
77
|
+
children: ({ activeBackground }) => (_jsxs(_Fragment, { children: [_jsxs(Label, Object.assign({ color: COLOR.PRIMARY, size: LABEL_SIZE.SM, sx: {
|
|
78
|
+
display: 'flex',
|
|
79
|
+
} }, { children: [_jsx(Icon, { icon: CalendarIcon, sx: { mr: 1 } }), "Monday, February 6 \u2013 Monday, July 31, 2023"] })), _jsxs(Label, Object.assign({ color: COLOR.PRIMARY, size: LABEL_SIZE.SM, sx: {
|
|
80
|
+
display: 'flex',
|
|
81
|
+
} }, { children: [_jsx(Icon, { icon: AccessTime, sx: { mr: 1 } }), "M-F: 9:30am \u2013 4:30pm"] })), _jsx(ReadMore, Object.assign({ typography: TYPOGRAPHY_TYPE.PARAGRAPH_MEDIUM, lines: 2, sx: { bg: activeBackground } }, { children: "This online exhibition displays rare materials from Hesburgh Libraries collections that place Mike Curato\u2019s teen graphic novel into a historical and social context." }))] })),
|
|
82
|
+
},
|
|
83
|
+
];
|
|
84
|
+
export const Default = {
|
|
85
|
+
render: () => (_jsx(Column, { children: headlinedCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i })))) })),
|
|
86
|
+
args: {},
|
|
87
|
+
};
|
|
88
|
+
export const TruncateHeadline = {
|
|
89
|
+
render: () => (_jsx(Column, { children: headlinedCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i, truncateHeadlineAfter: 2 })))) })),
|
|
90
|
+
args: {},
|
|
91
|
+
};
|
|
92
|
+
export const Horizontal = {
|
|
93
|
+
render: () => (_jsx(Column, { children: horizontalCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i, layout: CARD_LAYOUT.HORIZONTAL })))) })),
|
|
94
|
+
args: {},
|
|
95
|
+
};
|
|
96
|
+
export const DateCards = {
|
|
97
|
+
render: () => (_jsx(Column, { children: dateCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i, layout: CARD_LAYOUT.HORIZONTAL, sx: { height: '120px' } })))) })),
|
|
98
|
+
args: {},
|
|
99
|
+
};
|
|
100
|
+
export const Clickable = {
|
|
101
|
+
render: () => (_jsx(Column, { children: headlinedCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { onClick: () => {
|
|
102
|
+
alert('Card clicked');
|
|
103
|
+
}, key: i })))) })),
|
|
104
|
+
args: {},
|
|
105
|
+
};
|
|
106
|
+
export const Raised = {
|
|
107
|
+
render: () => (_jsx(Column, { children: basicCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { raised: true, key: i })))) })),
|
|
108
|
+
args: {},
|
|
109
|
+
};
|
|
110
|
+
export const Heading = {
|
|
111
|
+
render: () => (_jsx(Column, { children: basicCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i, heading: "Heading", headingIcon: BookmarkIcon, headingAction: _jsx(Button, Object.assign({ type: BUTTON_TYPE.TEXT, color: COLOR.WHITE, onClick: () => { } }, { children: "Click Me" })) })))) })),
|
|
112
|
+
args: {},
|
|
113
|
+
};
|
|
114
|
+
export const CustomImageHeading = {
|
|
115
|
+
render: () => (_jsx(Column, { children: basicCards.map((props, i) => (_createElement(Card, Object.assign({}, props, { key: i, heading: "Heading", headingStyles: {
|
|
116
|
+
backgroundImage: `url(https://library.nd.edu/static/media/jesus.2.4a2b137e.png)`,
|
|
117
|
+
backgroundRepeat: 'no-repeat',
|
|
118
|
+
backgroundPositionX: 'right',
|
|
119
|
+
backgrounndPositionY: '-15px',
|
|
120
|
+
} })))) })),
|
|
121
|
+
args: {},
|
|
122
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { fireEvent } from '@testing-library/react';
|
|
3
|
+
import { vi } from 'vitest';
|
|
4
|
+
import { render } from '../../../utils/test';
|
|
5
|
+
import { Card } from '.';
|
|
6
|
+
import { KEY_CODES } from '../../../utils/misc';
|
|
7
|
+
const MOCK_HEADLINE = 'MOCK HEADLINE';
|
|
8
|
+
const MOCK_BODY = 'MOCK BODY';
|
|
9
|
+
describe('Card', () => {
|
|
10
|
+
const mockClickHandler = vi.fn();
|
|
11
|
+
afterEach(() => {
|
|
12
|
+
vi.resetAllMocks();
|
|
13
|
+
});
|
|
14
|
+
it('renders contents', () => {
|
|
15
|
+
const { getByText } = render(_jsx(Card, Object.assign({ headline: MOCK_HEADLINE }, { children: MOCK_BODY })));
|
|
16
|
+
expect(getByText(MOCK_HEADLINE)).toBeDefined();
|
|
17
|
+
expect(getByText(MOCK_BODY)).toBeDefined();
|
|
18
|
+
});
|
|
19
|
+
it('fires handler when clicked', () => {
|
|
20
|
+
const { getByRole } = render(_jsx(Card, { headline: MOCK_HEADLINE, onClick: mockClickHandler }));
|
|
21
|
+
const card = getByRole('button');
|
|
22
|
+
fireEvent.click(card);
|
|
23
|
+
expect(mockClickHandler).toBeCalledTimes(1);
|
|
24
|
+
fireEvent.keyDown(card, {
|
|
25
|
+
key: KEY_CODES.ENTER,
|
|
26
|
+
});
|
|
27
|
+
expect(mockClickHandler).toBeCalledTimes(2);
|
|
28
|
+
});
|
|
29
|
+
it('labels card with headline when passed', () => {
|
|
30
|
+
const { getByLabelText } = render(_jsx(Card, { headline: MOCK_HEADLINE }));
|
|
31
|
+
expect(getByLabelText(MOCK_HEADLINE)).toBeDefined();
|
|
32
|
+
});
|
|
33
|
+
it('labels card with heading when passed', () => {
|
|
34
|
+
const { getByLabelText } = render(_jsx(Card, { heading: MOCK_HEADLINE }));
|
|
35
|
+
expect(getByLabelText(MOCK_HEADLINE)).toBeDefined();
|
|
36
|
+
});
|
|
37
|
+
});
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { StyledElementProps, StylesProp } from '../../../theme';
|
|
2
|
+
import { COLOR } from '../../../theme/colors';
|
|
3
|
+
import React from 'react';
|
|
4
|
+
export declare enum CARD_LAYOUT {
|
|
5
|
+
VERTICAL = "vertical",
|
|
6
|
+
HORIZONTAL = "horizontal"
|
|
7
|
+
}
|
|
8
|
+
export declare enum CARD_SIZE {
|
|
9
|
+
SM = "SM",
|
|
10
|
+
MD = "MD",
|
|
11
|
+
LG = "LG"
|
|
12
|
+
}
|
|
13
|
+
type CardState = {
|
|
14
|
+
isHovered: boolean;
|
|
15
|
+
activeBackground: COLOR;
|
|
16
|
+
};
|
|
17
|
+
type CardChildren = React.ReactNode | ((state: CardState) => React.ReactNode);
|
|
18
|
+
export type CardProps = StyledElementProps<HTMLDivElement, {
|
|
19
|
+
headline?: string;
|
|
20
|
+
heading?: string;
|
|
21
|
+
headingStyles?: StylesProp;
|
|
22
|
+
headingIcon?: React.FC;
|
|
23
|
+
headingAction?: React.ReactNode;
|
|
24
|
+
truncateHeadlineAfter?: number;
|
|
25
|
+
body?: React.ReactNode;
|
|
26
|
+
image?: string;
|
|
27
|
+
layout?: CARD_LAYOUT;
|
|
28
|
+
size?: CARD_SIZE;
|
|
29
|
+
displayDate?: string;
|
|
30
|
+
onClick?: () => void;
|
|
31
|
+
raised?: boolean;
|
|
32
|
+
imageHeight?: string;
|
|
33
|
+
imageWidth?: string;
|
|
34
|
+
}, CardChildren>;
|
|
35
|
+
export declare const Card: React.FC<CardProps>;
|
|
36
|
+
export {};
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { HEADING_SIZE, Heading } from '../../elements/text/Heading';
|
|
3
|
+
import { ReadMore } from '../../elements/text/ReadMore';
|
|
4
|
+
import { useTheme } from '../../../theme';
|
|
5
|
+
import { GROUP_TYPE, Group } from '../../elements/Group';
|
|
6
|
+
import { Box } from '../../elements/layout/Box';
|
|
7
|
+
import { Icon } from '../../elements/Icon';
|
|
8
|
+
import { Column, FONT, FONT_SIZE, Row, TYPOGRAPHY_TYPE } from '../../..';
|
|
9
|
+
import { COLOR } from '../../../theme/colors';
|
|
10
|
+
import React, { useEffect, useState } from 'react';
|
|
11
|
+
import { KEY_CODES } from '../../../utils/misc';
|
|
12
|
+
import { useHover } from '../../../utils/hooks/useHover';
|
|
13
|
+
export var CARD_LAYOUT;
|
|
14
|
+
(function (CARD_LAYOUT) {
|
|
15
|
+
CARD_LAYOUT["VERTICAL"] = "vertical";
|
|
16
|
+
CARD_LAYOUT["HORIZONTAL"] = "horizontal";
|
|
17
|
+
})(CARD_LAYOUT || (CARD_LAYOUT = {}));
|
|
18
|
+
export var CARD_SIZE;
|
|
19
|
+
(function (CARD_SIZE) {
|
|
20
|
+
CARD_SIZE["SM"] = "SM";
|
|
21
|
+
CARD_SIZE["MD"] = "MD";
|
|
22
|
+
CARD_SIZE["LG"] = "LG";
|
|
23
|
+
})(CARD_SIZE || (CARD_SIZE = {}));
|
|
24
|
+
const MONTH_LABELS = [
|
|
25
|
+
'JAN',
|
|
26
|
+
'FEB',
|
|
27
|
+
'MAR',
|
|
28
|
+
'APR',
|
|
29
|
+
'MAY',
|
|
30
|
+
'JUN',
|
|
31
|
+
'JUL',
|
|
32
|
+
'AUG',
|
|
33
|
+
'SEP',
|
|
34
|
+
'OCT',
|
|
35
|
+
'NOV',
|
|
36
|
+
'DEC',
|
|
37
|
+
];
|
|
38
|
+
const DateDisplay = ({ date: dateString }) => {
|
|
39
|
+
const date = React.useMemo(() => {
|
|
40
|
+
return new Date(dateString);
|
|
41
|
+
}, [dateString]);
|
|
42
|
+
return (_jsxs(Column, Object.assign({ sx: {
|
|
43
|
+
alignItems: 'center',
|
|
44
|
+
justifyContent: 'center',
|
|
45
|
+
p: 3,
|
|
46
|
+
fontFamily: FONT.BRANDED2,
|
|
47
|
+
backgroundColor: COLOR.ND_GOLD,
|
|
48
|
+
} }, { children: [_jsx(Box, Object.assign({ sx: {
|
|
49
|
+
fontSize: FONT_SIZE.LG,
|
|
50
|
+
} }, { children: date.getDate() })), _jsx(Box, Object.assign({ sx: {
|
|
51
|
+
fontSize: FONT_SIZE.MD,
|
|
52
|
+
mt: 1,
|
|
53
|
+
} }, { children: MONTH_LABELS[date.getMonth()] }))] })));
|
|
54
|
+
};
|
|
55
|
+
export const Card = ({ size, displayDate, headline, image, layout, onClick, raised, truncateHeadlineAfter, heading, headingStyles, headingIcon, headingAction, sx, imageHeight: imageHeightProp, imageWidth: imageWidthProp, children, }) => {
|
|
56
|
+
const theme = useTheme();
|
|
57
|
+
const contentPaddingX = size === CARD_SIZE.SM ? 3 : 4;
|
|
58
|
+
const isVertical = !layout || layout === CARD_LAYOUT.VERTICAL;
|
|
59
|
+
const { isHovered, anchorElementProps } = useHover();
|
|
60
|
+
const [activeBackground, setActiveBackground] = useState(isHovered ? COLOR.ND_SKY_BLUE : COLOR.BACKGROUND);
|
|
61
|
+
const imageHeight = imageHeightProp || (isVertical ? 'auto' : '100%');
|
|
62
|
+
const imageWidth = imageWidthProp || (isVertical ? '100%' : 'auto');
|
|
63
|
+
useEffect(() => {
|
|
64
|
+
setActiveBackground(isHovered ? COLOR.ND_SKY_BLUE : COLOR.BACKGROUND);
|
|
65
|
+
}, [isHovered]);
|
|
66
|
+
const contentPaddingY = isVertical ? contentPaddingX : 2;
|
|
67
|
+
const typography = size === CARD_SIZE.SM
|
|
68
|
+
? TYPOGRAPHY_TYPE.HEADLINE_SMALL
|
|
69
|
+
: TYPOGRAPHY_TYPE.HEADLINE_MEDIUM;
|
|
70
|
+
return (_jsxs(Group, Object.assign({}, anchorElementProps, { type: headline || heading ? GROUP_TYPE.REGION : GROUP_TYPE.GROUP, role: onClick ? 'button' : 'group', onClick: onClick, onKeyDown: (e) => {
|
|
71
|
+
if (onClick && e.key === KEY_CODES.ENTER) {
|
|
72
|
+
onClick();
|
|
73
|
+
}
|
|
74
|
+
}, tabIndex: onClick ? 0 : undefined, sx: Object.assign({ boxShadow: raised || heading ? theme.boxShadow.NORMAL : undefined, width: !isVertical && '100%', borderBottom: 'solid 2px', borderColor: COLOR.TRANSPARENT, cursor: onClick ? 'pointer' : undefined, display: 'flex', flexDirection: layout === CARD_LAYOUT.HORIZONTAL ? 'row' : 'column', alignItems: 'flex-start', ':hover,:focus': onClick
|
|
75
|
+
? {
|
|
76
|
+
transform: 'scale(1.01)',
|
|
77
|
+
borderColor: COLOR.ND_SKY_BLUE_DARK,
|
|
78
|
+
backgroundColor: COLOR.ND_SKY_BLUE,
|
|
79
|
+
}
|
|
80
|
+
: {} }, sx) }, { children: [image && (_jsx("img", { src: image, style: {
|
|
81
|
+
width: imageWidth,
|
|
82
|
+
height: imageHeight,
|
|
83
|
+
} })), displayDate && _jsx(DateDisplay, { date: displayDate }), heading && (_jsxs(Row, Object.assign({ sx: Object.assign({ bg: COLOR.PRIMARY, color: COLOR.WHITE, width: '100%', px: contentPaddingX, py: 3, justifyContent: 'space-between', alignItems: 'center' }, headingStyles) }, { children: [_jsxs(Row, { children: [headingIcon && (_jsx(Icon, { icon: headingIcon, size: FONT_SIZE.LG, color: COLOR.WHITE, sx: { mr: 2 } })), _jsx(Heading, Object.assign({ size: HEADING_SIZE.SM, sx: {
|
|
84
|
+
color: COLOR.WHITE,
|
|
85
|
+
whiteSpace: 'nowrap',
|
|
86
|
+
} }, { children: heading }))] }), _jsx(Row, { children: headingAction && headingAction })] }))), _jsx(Row, Object.assign({ sx: { px: contentPaddingX, py: contentPaddingY } }, { children: _jsxs(Column, Object.assign({ justify: "center" }, { children: [headline && (_jsx(Heading, Object.assign({ typography: typography }, { children: truncateHeadlineAfter ? (_jsx(ReadMore, Object.assign({ lines: truncateHeadlineAfter, typography: typography, sx: { bg: activeBackground } }, { children: headline }))) : (headline) }))), children && (_jsx(Box, Object.assign({ sx: { mt: headline && !heading ? 2 : 0 } }, { children: typeof children === 'function'
|
|
87
|
+
? children({ isHovered, activeBackground })
|
|
88
|
+
: children })))] })) }))] })));
|
|
89
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from '@storybook/react';
|
|
2
|
+
import { DragDropList } from './index';
|
|
3
|
+
declare const meta: Meta<typeof DragDropList>;
|
|
4
|
+
export default meta;
|
|
5
|
+
type Story = StoryObj<typeof DragDropList>;
|
|
6
|
+
export declare const Default: Story;
|
|
7
|
+
export declare const Disabled: Story;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { DragDropList, DragHandle } from './index';
|
|
3
|
+
import React from 'react';
|
|
4
|
+
import { Paragraph } from '../../elements/text/Paragraph';
|
|
5
|
+
const meta = {
|
|
6
|
+
title: 'Composites/DragDropList',
|
|
7
|
+
component: DragDropList,
|
|
8
|
+
tags: ['autodocs'],
|
|
9
|
+
};
|
|
10
|
+
export default meta;
|
|
11
|
+
const _items = [
|
|
12
|
+
{
|
|
13
|
+
id: '1',
|
|
14
|
+
label: 'Foo',
|
|
15
|
+
accessibleLabel: 'Foo',
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
id: '2',
|
|
19
|
+
label: 'Bar',
|
|
20
|
+
accessibleLabel: 'Bar',
|
|
21
|
+
},
|
|
22
|
+
];
|
|
23
|
+
const StateManager = ({ children }) => {
|
|
24
|
+
const [items, setItems] = React.useState(_items);
|
|
25
|
+
return _jsx(_Fragment, { children: children({ items, setItems }) });
|
|
26
|
+
};
|
|
27
|
+
export const Default = {
|
|
28
|
+
render: () => (_jsx(StateManager, { children: ({ items, setItems }) => (_jsx(DragDropList, Object.assign({ items: items, onReorder: ({ reorderedList }) => setItems(reorderedList) }, { children: ({ item }) => (_jsx(_Fragment, { children: _jsx(Paragraph, Object.assign({ sx: { ml: 2 } }, { children: item.label })) })) }))) })),
|
|
29
|
+
};
|
|
30
|
+
export const Disabled = {
|
|
31
|
+
render: () => (_jsx(DragDropList, Object.assign({ disabled: true, items: _items, onReorder: () => { } }, { children: ({ item }) => (_jsxs(_Fragment, { children: [_jsx(DragHandle, {}), _jsx(Paragraph, Object.assign({ sx: { ml: 2 } }, { children: item.label }))] })) }))),
|
|
32
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { DropResult } from 'react-beautiful-dnd';
|
|
3
|
+
import { StylesProp } from '../../../theme';
|
|
4
|
+
import { ButtonProps } from '../../elements/Button';
|
|
5
|
+
type DraggableItem = {
|
|
6
|
+
accessibleLabel: string;
|
|
7
|
+
};
|
|
8
|
+
type DragDropListProps<Item extends DraggableItem> = {
|
|
9
|
+
onReorder: (params: {
|
|
10
|
+
reorderedList: Item[];
|
|
11
|
+
dropEvent: DropResult;
|
|
12
|
+
}) => void;
|
|
13
|
+
items: Item[];
|
|
14
|
+
itemIdKey?: keyof Item;
|
|
15
|
+
wrapperStyles?: StylesProp;
|
|
16
|
+
itemStyles?: StylesProp;
|
|
17
|
+
disabled?: boolean;
|
|
18
|
+
children: (params: {
|
|
19
|
+
item: Item;
|
|
20
|
+
index: number;
|
|
21
|
+
}) => React.ReactNode;
|
|
22
|
+
};
|
|
23
|
+
export declare const DragHandle: React.FC<ButtonProps>;
|
|
24
|
+
export declare function DragDropList<Item extends DraggableItem>({ items, itemIdKey, wrapperStyles, itemStyles, children: renderChild, onReorder, disabled, }: DragDropListProps<Item>): import("react/jsx-runtime").JSX.Element;
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
2
|
+
var t = {};
|
|
3
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
4
|
+
t[p] = s[p];
|
|
5
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
6
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
7
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
8
|
+
t[p[i]] = s[p[i]];
|
|
9
|
+
}
|
|
10
|
+
return t;
|
|
11
|
+
};
|
|
12
|
+
import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
|
|
13
|
+
import { DragDropContext, Droppable, Draggable, } from 'react-beautiful-dnd';
|
|
14
|
+
import _DragIndicator from '@mui/icons-material/DragIndicator';
|
|
15
|
+
import { BUTTON_TYPE, Button } from '../../elements/Button';
|
|
16
|
+
import { Column } from '../../elements/layout/Column';
|
|
17
|
+
import { Row } from '../../elements/layout/Row';
|
|
18
|
+
import { useUniqueId } from '../../providers/uniqueIds';
|
|
19
|
+
import { importedDefaultComponentShim } from '../../../utils/misc';
|
|
20
|
+
const DragIndicator = importedDefaultComponentShim(_DragIndicator);
|
|
21
|
+
export const DragHandle = (_a) => {
|
|
22
|
+
var { sx } = _a, props = __rest(_a, ["sx"]);
|
|
23
|
+
return (_jsx(Button, Object.assign({ type: BUTTON_TYPE.TEXT, primaryIcon: DragIndicator, disableFocusStyles: true, sx: Object.assign({ cursor: 'inherit' }, sx) }, props)));
|
|
24
|
+
};
|
|
25
|
+
export function DragDropList({ items, itemIdKey = 'id', wrapperStyles, itemStyles, children: renderChild, onReorder, disabled, }) {
|
|
26
|
+
const id = useUniqueId('dnd-list');
|
|
27
|
+
return (_jsx(DragDropContext, Object.assign({ onDragStart: (start, provided) => {
|
|
28
|
+
const selectedItem = items.find((item) => String(item[itemIdKey]) === start.draggableId);
|
|
29
|
+
provided.announce(`Selected item: ${selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.accessibleLabel}`);
|
|
30
|
+
}, onDragEnd: (e) => {
|
|
31
|
+
if (e.destination &&
|
|
32
|
+
e.source &&
|
|
33
|
+
e.destination.index !== e.source.index) {
|
|
34
|
+
const reordered = Array.from(items);
|
|
35
|
+
const [removed] = reordered.splice(e.source.index, 1);
|
|
36
|
+
reordered.splice(e.destination.index, 0, removed);
|
|
37
|
+
onReorder({
|
|
38
|
+
reorderedList: reordered,
|
|
39
|
+
dropEvent: e,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
} }, { children: _jsx(Droppable, Object.assign({ droppableId: id }, { children: (droppable) => (_jsx(Column, Object.assign({}, droppable.droppableProps, { sx: wrapperStyles, ref: droppable.innerRef }, { children: _jsxs(_Fragment, { children: [items.map((item, index) => (_jsx(Draggable, Object.assign({ draggableId: String(item[itemIdKey]), isDragDisabled: disabled, index: index }, { children: (draggable) => {
|
|
43
|
+
return (_jsx(Row, Object.assign({ sx: {
|
|
44
|
+
alignItems: 'center',
|
|
45
|
+
itemStyles,
|
|
46
|
+
}, ref: draggable.innerRef }, draggable.draggableProps, draggable.dragHandleProps, { "aria-describedby": `item-${index}` }, { children: _jsx(Row, Object.assign({ sx: { mt: 1 }, id: `item-${index}` }, { children: renderChild({ item, index }) })) })));
|
|
47
|
+
} }), String(item[itemIdKey])))), droppable.placeholder] }) }))) })) })));
|
|
48
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { Meta, StoryObj } from '@storybook/react';
|
|
2
|
+
import { DropdownLinks } from '.';
|
|
3
|
+
declare const meta: Meta<typeof DropdownLinks>;
|
|
4
|
+
export default meta;
|
|
5
|
+
type Story = StoryObj<typeof DropdownLinks>;
|
|
6
|
+
export declare const Default: Story;
|
|
7
|
+
export declare const Right: Story;
|
|
8
|
+
export declare const OpenInNewTab: Story;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import ArrowDropDownIcon from '@mui/icons-material/ArrowDropDown';
|
|
3
|
+
import { DropdownLinks } from '.';
|
|
4
|
+
import { Button } from '../../elements/Button';
|
|
5
|
+
import { Box } from '../../elements/layout/Box';
|
|
6
|
+
import { Row } from '../../elements/layout/Row';
|
|
7
|
+
const meta = {
|
|
8
|
+
title: 'Composites/DropdownLinks',
|
|
9
|
+
component: DropdownLinks,
|
|
10
|
+
tags: ['autodocs'],
|
|
11
|
+
};
|
|
12
|
+
export default meta;
|
|
13
|
+
const options = [
|
|
14
|
+
{ value: 'https://google.com', label: 'Google' },
|
|
15
|
+
{ value: 'https://facebook.com', label: 'This is intentionally long' },
|
|
16
|
+
];
|
|
17
|
+
export const Default = {
|
|
18
|
+
render: () => (_jsx(Box, Object.assign({ sx: { width: '200px', height: '200px' } }, { children: _jsx(DropdownLinks, Object.assign({ options: options }, { children: ({ anchorProps }) => (_jsx(Button, Object.assign({}, anchorProps, { rightIcon: ArrowDropDownIcon }, { children: "Links" }))) })) }))),
|
|
19
|
+
};
|
|
20
|
+
export const Right = {
|
|
21
|
+
render: () => (_jsx(Row, Object.assign({ sx: { width: '90vw', height: '200px' }, justify: "flex-end" }, { children: _jsx(DropdownLinks, Object.assign({ options: options }, { children: ({ anchorProps }) => (_jsx(Button, Object.assign({}, anchorProps, { rightIcon: ArrowDropDownIcon }, { children: "Links" }))) })) }))),
|
|
22
|
+
};
|
|
23
|
+
export const OpenInNewTab = {
|
|
24
|
+
render: () => (_jsx(Box, Object.assign({ sx: { width: '200px', height: '200px' } }, { children: _jsx(DropdownLinks, Object.assign({ options: options, openNewTab: true }, { children: ({ anchorProps }) => _jsx(Button, Object.assign({}, anchorProps, { children: "Links" })) })) }))),
|
|
25
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { render } from '../../../utils/test';
|
|
3
|
+
import { DropdownLinks } from '.';
|
|
4
|
+
import { Button } from '../../elements/Button';
|
|
5
|
+
import { fireEvent } from '@testing-library/react';
|
|
6
|
+
const options = [
|
|
7
|
+
{ value: 'https://google.com', label: 'Google' },
|
|
8
|
+
{ value: 'https://facebook.com', label: 'Facebook' },
|
|
9
|
+
];
|
|
10
|
+
const DropdownExample = (_jsx(DropdownLinks, Object.assign({ options: options }, { children: ({ anchorProps }) => _jsx(Button, Object.assign({}, anchorProps, { children: "Links" })) })));
|
|
11
|
+
describe('DropdownLinks', () => {
|
|
12
|
+
it('toggle links when button is clicked', () => {
|
|
13
|
+
const { getByRole, getAllByRole } = render(DropdownExample);
|
|
14
|
+
expect(() => getByRole('link')).toThrow();
|
|
15
|
+
expect(() => getByRole('navigation')).toThrow();
|
|
16
|
+
const button = getByRole('button');
|
|
17
|
+
expect(button).not.toHaveAttribute('aria-expanded', 'true');
|
|
18
|
+
fireEvent.click(button);
|
|
19
|
+
expect(button).toHaveAttribute('aria-expanded', 'true');
|
|
20
|
+
expect(getAllByRole('link')).toHaveLength(2);
|
|
21
|
+
expect(getByRole('navigation')).toBeDefined();
|
|
22
|
+
fireEvent.click(button);
|
|
23
|
+
expect(button).not.toHaveAttribute('aria-expanded', 'true');
|
|
24
|
+
expect(() => getByRole('link')).toThrow();
|
|
25
|
+
expect(() => getByRole('navigation')).toThrow();
|
|
26
|
+
});
|
|
27
|
+
});
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { BasicOption, RenderOption } from '../../elements/Fields/option';
|
|
3
|
+
import { StyledElementProps } from '../../../theme';
|
|
4
|
+
type AnchorProps = Omit<React.HTMLAttributes<HTMLButtonElement>, 'color'>;
|
|
5
|
+
type LinkOption = BasicOption<string>;
|
|
6
|
+
type DropdownChildrenFn = (params: {
|
|
7
|
+
anchorProps: AnchorProps;
|
|
8
|
+
}) => React.ReactNode;
|
|
9
|
+
type DropdownLinksProps = StyledElementProps<HTMLDivElement, {
|
|
10
|
+
options: BasicOption<string>[];
|
|
11
|
+
renderOption?: RenderOption<string, LinkOption>;
|
|
12
|
+
openNewTab?: boolean;
|
|
13
|
+
}, DropdownChildrenFn>;
|
|
14
|
+
export declare const DropdownLinks: React.FC<DropdownLinksProps>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { ListBox } from '../../elements/ListBox';
|
|
3
|
+
import { Link } from '../../elements/Link';
|
|
4
|
+
import { useComponentConfig } from '../../providers/componentConfig';
|
|
5
|
+
import { Dropdown } from '../../elements/Dropdown';
|
|
6
|
+
export const DropdownLinks = ({ children, options: optionsParam, renderOption: renderOptionParam, openNewTab, role = 'navigation', }) => {
|
|
7
|
+
const { navigate } = useComponentConfig().link;
|
|
8
|
+
const renderOption = renderOptionParam
|
|
9
|
+
? renderOptionParam
|
|
10
|
+
: (params) => (_jsx(Link, Object.assign({ to: params.option.value, target: openNewTab ? '_blank' : undefined, onClick: (e) => {
|
|
11
|
+
e.preventDefault();
|
|
12
|
+
} }, { children: params.option.label })));
|
|
13
|
+
return (_jsx(Dropdown, { shouldRenderDropdownContainer: false, renderAnchor: children, renderDropdown: ({ ref, styles, id, setIsOpen }) => {
|
|
14
|
+
const options = optionsParam.map((option) => (Object.assign(Object.assign({}, option), { onClick: () => {
|
|
15
|
+
if (option.onClick) {
|
|
16
|
+
option.onClick();
|
|
17
|
+
}
|
|
18
|
+
else if (openNewTab) {
|
|
19
|
+
window.open(option.value, '_blank');
|
|
20
|
+
}
|
|
21
|
+
else if (option.value) {
|
|
22
|
+
navigate(option.value);
|
|
23
|
+
}
|
|
24
|
+
setIsOpen(false);
|
|
25
|
+
} })));
|
|
26
|
+
return (_jsx(ListBox, { role: role, id: id, options: options, ref: ref, renderOption: renderOption, style: styles }));
|
|
27
|
+
} }));
|
|
28
|
+
};
|