fix(UIShell): Export prop types for components (#14657)

* fix(UIShell): Export prop types for components * fix(ui-shell): fix build issues flagged by CI --------- Co-authored-by: Taylor Jones <[email protected]> Co-authored-by: TJ Egan <[email protected]>
carbon-design-system · Sep 20, 2023 · c939468 · c939468
1 parent 13333a2
commit c939468
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 19 deletions.
diff --git a/packages/react/src/components/Link/Link.tsx b/packages/react/src/components/Link/Link.tsx
@@ -16,7 +16,7 @@ import React, {
 } from 'react';
 import { usePrefix } from '../../internal/usePrefix';
 
-interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
+export interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
   /**
    * @description Indicates the element that represents the
    *   current item within a container or set of related

diff --git a/packages/react/src/components/Link/index.tsx b/packages/react/src/components/Link/index.tsx
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import Link from './Link';
+import Link, { type LinkProps } from './Link';
 
 export default Link;
-export { Link };
+export { Link, type LinkProps };
diff --git a/packages/react/src/components/UIShell/HeaderContainer.tsx b/packages/react/src/components/UIShell/HeaderContainer.tsx
@@ -15,7 +15,7 @@ interface HeaderContainerRenderProps {
   onClickSideNavExpand: () => void;
 }
 
-interface HeaderContainerProps {
+export interface HeaderContainerProps {
   isSideNavExpanded?: boolean;
   render: React.ComponentType<HeaderContainerRenderProps>;
 }

diff --git a/packages/react/src/components/UIShell/HeaderMenuButton.tsx b/packages/react/src/components/UIShell/HeaderMenuButton.tsx
@@ -18,7 +18,7 @@ type HeaderMenuButtonBaseProps = Omit<
   'title' | 'type'
 >;
 
-interface HeaderMenuButtonProps extends HeaderMenuButtonBaseProps {
+export interface HeaderMenuButtonProps extends HeaderMenuButtonBaseProps {
   'aria-label'?: string;
   'aria-labelledby'?: string;
   className?: string;

diff --git a/packages/react/src/components/UIShell/HeaderMenuItem.tsx b/packages/react/src/components/UIShell/HeaderMenuItem.tsx
@@ -19,7 +19,7 @@ import Link, { LinkProps, LinkPropTypes } from './Link';
 import { usePrefix } from '../../internal/usePrefix';
 import deprecate from '../../prop-types/deprecate';
 
-type HeaderMenuItemProps<E extends ElementType> = LinkProps<E> & {
+export type HeaderMenuItemProps<E extends ElementType> = LinkProps<E> & {
   className?: string | undefined;
   isActive?: boolean | undefined;
   isCurrentPage?: boolean | undefined;

diff --git a/packages/react/src/components/UIShell/HeaderName.tsx b/packages/react/src/components/UIShell/HeaderName.tsx
@@ -11,7 +11,7 @@ import PropTypes from 'prop-types';
 import Link, { type LinkProps, LinkPropTypes } from './Link';
 import { usePrefix } from '../../internal/usePrefix';
 
-type HeaderNameProps<E extends ElementType> = LinkProps<E> & {
+export type HeaderNameProps<E extends ElementType> = LinkProps<E> & {
   prefix?: string | undefined;
 };
 

diff --git a/packages/react/src/components/UIShell/HeaderNavigation.tsx b/packages/react/src/components/UIShell/HeaderNavigation.tsx
@@ -11,7 +11,7 @@ import PropTypes from 'prop-types';
 import { AriaLabelPropType } from '../../prop-types/AriaPropTypes';
 import { usePrefix } from '../../internal/usePrefix';
 
-type HeaderNavigationProps = ComponentProps<'nav'>;
+export type HeaderNavigationProps = ComponentProps<'nav'>;
 
 export default function HeaderNavigation({
   'aria-label': ariaLabel,

diff --git a/packages/react/src/components/UIShell/HeaderSideNavItems.tsx b/packages/react/src/components/UIShell/HeaderSideNavItems.tsx
@@ -10,7 +10,7 @@ import React, { type ReactNode } from 'react';
 import PropTypes from 'prop-types';
 import { usePrefix } from '../../internal/usePrefix';
 
-interface HeaderSideNavItemsProps {
+export interface HeaderSideNavItemsProps {
   className?: string | undefined;
   children?: ReactNode;
   hasDivider?: boolean | undefined;

diff --git a/packages/react/src/components/UIShell/SideNav.tsx b/packages/react/src/components/UIShell/SideNav.tsx
@@ -28,7 +28,7 @@ import { useMatchMedia } from '../../internal/useMatchMedia';
 // TO-DO: comment back in when footer is added for rails
 // import SideNavFooter from './SideNavFooter';
 
-interface SideNavProps extends ComponentProps<'nav'> {
+export interface SideNavProps extends ComponentProps<'nav'> {
   expanded?: boolean | undefined;
   defaultExpanded?: boolean | undefined;
   isChildOfHeader?: boolean | undefined;

diff --git a/packages/react/src/components/UIShell/SkipToContent.tsx b/packages/react/src/components/UIShell/SkipToContent.tsx
@@ -10,7 +10,7 @@ import React, { ComponentProps } from 'react';
 import PropTypes from 'prop-types';
 import { usePrefix } from '../../internal/usePrefix';
 
-type SkipToContentProps = Omit<ComponentProps<'a'>, 'children'> & {
+export type SkipToContentProps = Omit<ComponentProps<'a'>, 'children'> & {
   children?: string | undefined;
 };
 

diff --git a/packages/react/src/components/UIShell/index.ts b/packages/react/src/components/UIShell/index.ts
@@ -8,23 +8,41 @@
 export { default as Content } from './Content';
 
 export { default as Header } from './Header';
-export { default as HeaderContainer } from './HeaderContainer';
+export {
+  default as HeaderContainer,
+  type HeaderContainerProps,
+} from './HeaderContainer';
 export { default as HeaderGlobalAction } from './HeaderGlobalAction';
 export { default as HeaderGlobalBar } from './HeaderGlobalBar';
 export { default as HeaderMenu } from './HeaderMenu';
-export { default as HeaderMenuButton } from './HeaderMenuButton';
-export { default as HeaderMenuItem } from './HeaderMenuItem';
-export { default as HeaderName } from './HeaderName';
-export { default as HeaderNavigation } from './HeaderNavigation';
+export {
+  default as HeaderMenuButton,
+  type HeaderMenuButtonProps,
+} from './HeaderMenuButton';
+export {
+  default as HeaderMenuItem,
+  type HeaderMenuItemProps,
+} from './HeaderMenuItem';
+export { default as HeaderName, type HeaderNameProps } from './HeaderName';
+export {
+  default as HeaderNavigation,
+  type HeaderNavigationProps,
+} from './HeaderNavigation';
 export { default as HeaderPanel } from './HeaderPanel';
-export { default as HeaderSideNavItems } from './HeaderSideNavItems';
+export {
+  default as HeaderSideNavItems,
+  type HeaderSideNavItemsProps,
+} from './HeaderSideNavItems';
 export { default as Switcher } from './Switcher';
 export { default as SwitcherItem } from './SwitcherItem';
 export { default as SwitcherDivider } from './SwitcherDivider';
 
-export { default as SkipToContent } from './SkipToContent';
+export {
+  default as SkipToContent,
+  type SkipToContentProps,
+} from './SkipToContent';
 
-export { default as SideNav } from './SideNav';
+export { default as SideNav, type SideNavProps } from './SideNav';
 export { default as SideNavDetails } from './SideNavDetails';
 export { default as SideNavDivider } from './SideNavDivider';
 export { default as SideNavFooter } from './SideNavFooter';