From d485245e1e67eafd5c3db6118732bd1a3cfff98c Mon Sep 17 00:00:00 2001 From: Frida Erdal <31915755+pomfrida@users.noreply.github.com> Date: Tue, 20 Oct 2020 10:26:48 +0200 Subject: [PATCH] Breadcrumbs Types (#700) * changed to tsx * Breadcrumb to typescript * Breadcrumbs to typescript * index to typescript * Small typo change * Removed blank line * Removed another empty linke * Another empty line --- .../{Breadcrumb.jsx => Breadcrumb.tsx} | 53 ++++++++----------- ...adcrumbs.test.jsx => Breadcrumbs.test.tsx} | 0 ...crumbs.tokens.js => Breadcrumbs.tokens.ts} | 1 - .../{Breadcrumbs.jsx => Breadcrumbs.tsx} | 30 +++-------- libraries/core-react/src/Breadcrumbs/index.js | 7 --- libraries/core-react/src/Breadcrumbs/index.ts | 12 +++++ 6 files changed, 42 insertions(+), 61 deletions(-) rename libraries/core-react/src/Breadcrumbs/{Breadcrumb.jsx => Breadcrumb.tsx} (54%) rename libraries/core-react/src/Breadcrumbs/{Breadcrumbs.test.jsx => Breadcrumbs.test.tsx} (100%) rename libraries/core-react/src/Breadcrumbs/{Breadcrumbs.tokens.js => Breadcrumbs.tokens.ts} (97%) rename libraries/core-react/src/Breadcrumbs/{Breadcrumbs.jsx => Breadcrumbs.tsx} (82%) delete mode 100644 libraries/core-react/src/Breadcrumbs/index.js create mode 100644 libraries/core-react/src/Breadcrumbs/index.ts diff --git a/libraries/core-react/src/Breadcrumbs/Breadcrumb.jsx b/libraries/core-react/src/Breadcrumbs/Breadcrumb.tsx similarity index 54% rename from libraries/core-react/src/Breadcrumbs/Breadcrumb.jsx rename to libraries/core-react/src/Breadcrumbs/Breadcrumb.tsx index 18285399fc..953fb0feb4 100644 --- a/libraries/core-react/src/Breadcrumbs/Breadcrumb.jsx +++ b/libraries/core-react/src/Breadcrumbs/Breadcrumb.tsx @@ -1,12 +1,12 @@ -// @ts-nocheck import React, { forwardRef } from 'react' -import PropTypes from 'prop-types' import styled, { css } from 'styled-components' import { Typography } from '../Typography' import { Tooltip } from '../Tooltip' import { breadcrumbs as tokens } from './Breadcrumbs.tokens' -const StyleTypography = styled(Typography)` +type StyledProps = Pick + +const StyledTypography = styled(Typography)` &:hover { text-decoration: underline; color: ${tokens.colors.hover}; @@ -27,13 +27,24 @@ const StyleTypography = styled(Typography)` ${({ maxWidth }) => css({ maxWidth })} ` -export const Breadcrumb = forwardRef(function Breadcrumb( - { className, children, maxWidth, ...rest }, +type Props = { + /* Max label width in pixels, + * truncate long labels based on this width */ + maxWidth?: number + /* click handler function */ + onClick?: () => void + /** Children is breadcrumb text */ + children: string + /** Classname */ + className?: string +} + +export const Breadcrumb = forwardRef(function Breadcrumb( + { children, maxWidth, ...other }, ref, ) { const props = { - ...rest, - className, + ...other, ref, maxWidth: maxWidth, } @@ -42,39 +53,19 @@ export const Breadcrumb = forwardRef(function Breadcrumb( const WithTooltip = ( - + {children} - + ) return tooltip ? ( WithTooltip ) : ( - + {children} - + ) }) Breadcrumb.displayName = 'eds-breadcrumb' - -Breadcrumb.propTypes = { - /* - * Max label width in pixels, - * truncate long labels based on this width - */ - maxWidth: PropTypes.number, - // click handler function - onClick: PropTypes.func, - // Breadcrumb children - children: PropTypes.node.isRequired, - /** @ignore */ - className: PropTypes.string, -} - -Breadcrumb.defaultProps = { - maxWidth: undefined, - className: '', - onClick: () => {}, -} diff --git a/libraries/core-react/src/Breadcrumbs/Breadcrumbs.test.jsx b/libraries/core-react/src/Breadcrumbs/Breadcrumbs.test.tsx similarity index 100% rename from libraries/core-react/src/Breadcrumbs/Breadcrumbs.test.jsx rename to libraries/core-react/src/Breadcrumbs/Breadcrumbs.test.tsx diff --git a/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.js b/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.ts similarity index 97% rename from libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.js rename to libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.ts index 30a439b369..91750be171 100644 --- a/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.js +++ b/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tokens.ts @@ -1,4 +1,3 @@ -// @ts-nocheck import { tokens } from '@equinor/eds-tokens' const { diff --git a/libraries/core-react/src/Breadcrumbs/Breadcrumbs.jsx b/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tsx similarity index 82% rename from libraries/core-react/src/Breadcrumbs/Breadcrumbs.jsx rename to libraries/core-react/src/Breadcrumbs/Breadcrumbs.tsx index cdc48af26c..2b696cf920 100644 --- a/libraries/core-react/src/Breadcrumbs/Breadcrumbs.jsx +++ b/libraries/core-react/src/Breadcrumbs/Breadcrumbs.tsx @@ -1,6 +1,4 @@ -// @ts-nocheck import React, { forwardRef, useState, Fragment } from 'react' -import PropTypes from 'prop-types' import styled from 'styled-components' import { breadcrumbs as tokens } from './Breadcrumbs.tokens' import { Typography } from '../Typography' @@ -38,13 +36,18 @@ const Collapsed = styled(Typography)` text-decoration: none; ` -export const Breadcrumbs = forwardRef(function Breadcrumbs( - { className, children, collapse, ...rest }, +type Props = { + /* Collapses the list of breadcrumbs so that only the first + * and last breadcrumb will be shown, with an ellipsis in between. */ + collapse?: boolean +} & JSX.IntrinsicElements['nav'] + +export const Breadcrumbs = forwardRef(function Breadcrumbs( + { children, collapse, ...rest }, ref, ) { const props = { ...rest, - className, ref, } @@ -103,20 +106,3 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs( }) Breadcrumbs.displayName = 'eds-breadcrumbs' - -Breadcrumbs.propTypes = { - /* - * Collapses the list of breadcrumbs so that only the first - * and last breadcrumb will be shown, with an ellipsis in between. - */ - collapse: PropTypes.bool, - // Breadcrumbs children - children: PropTypes.node.isRequired, - /** @ignore */ - className: PropTypes.string, -} - -Breadcrumbs.defaultProps = { - className: '', - collapse: false, -} diff --git a/libraries/core-react/src/Breadcrumbs/index.js b/libraries/core-react/src/Breadcrumbs/index.js deleted file mode 100644 index 915914c6f7..0000000000 --- a/libraries/core-react/src/Breadcrumbs/index.js +++ /dev/null @@ -1,7 +0,0 @@ -// @ts-nocheck -import { Breadcrumbs } from './Breadcrumbs' -import { Breadcrumb } from './Breadcrumb' - -Breadcrumbs.Breadcrumb = Breadcrumb - -export { Breadcrumbs } diff --git a/libraries/core-react/src/Breadcrumbs/index.ts b/libraries/core-react/src/Breadcrumbs/index.ts new file mode 100644 index 0000000000..4b0add2e61 --- /dev/null +++ b/libraries/core-react/src/Breadcrumbs/index.ts @@ -0,0 +1,12 @@ +import { Breadcrumbs as BaseComponent } from './Breadcrumbs' +import { Breadcrumb } from './Breadcrumb' + +type BreadcrumbsTypes = typeof BaseComponent & { + Breadcrumb: typeof Breadcrumb +} + +const Breadcrumbs = BaseComponent as BreadcrumbsTypes + +Breadcrumbs.Breadcrumb = Breadcrumb + +export { Breadcrumbs }