@okta/odyssey-react-mui 1.32.0 → 1.33.0

package/src/ui-shell/SideNav/SortableList/SortableList.tsx

@@ -1,132 +0,0 @@
-/*!
- * Copyright (c) 2024-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-import { Fragment, useMemo, useState } from "react";
-import type { ReactNode } from "react";
-import { useTranslation } from "react-i18next";
-import {
-  Active,
-  Announcements,
-  DndContext,
-  KeyboardSensor,
-  PointerSensor,
-  UniqueIdentifier,
-  useSensor,
-  useSensors,
-} from "@dnd-kit/core";
-import {
-  SortableContext,
-  sortableKeyboardCoordinates,
-} from "@dnd-kit/sortable";
-
-import { SortableItem } from "./SortableItem.js";
-import { SortableOverlay } from "./SortableOverlay.js";
-
-export interface BaseItem {
-  id: UniqueIdentifier;
-  isDisabled: boolean | undefined;
-  isSelected: boolean | undefined;
-  isSortable: boolean | undefined;
-  navItem: ReactNode;
-}
-
-interface ListProps<T extends BaseItem> {
-  parentId: string;
-  items: T[];
-  onChange: (
-    parentId: string,
-    activeId: UniqueIdentifier,
-    activeIndex: number,
-    overIndex: number,
-  ) => void;
-  renderItem: (item: T) => ReactNode;
-}
-
-export const SortableList = <T extends BaseItem>({
-  parentId,
-  items,
-  onChange,
-  renderItem,
-}: ListProps<T>) => {
-  const [active, setActive] = useState<Active | null>(null);
-
-  const activeItem = useMemo(
-    () => items.find((item) => item.id === active?.id),
-    [active, items],
-  );
-  const sensors = useSensors(
-    useSensor(PointerSensor),
-    useSensor(KeyboardSensor, {
-      coordinateGetter: sortableKeyboardCoordinates,
-    }),
-  );
-
-  const { t } = useTranslation();
-  const announcements: Announcements = useMemo(
-    () => ({
-      onDragStart: ({ active }) => {
-        return `${t("sortable.list.drag.start", { activeId: active.id })}`;
-      },
-      onDragOver: ({ active, over }) => {
-        if (over) {
-          return `${t("sortable.list.drag.moved.over", { activeId: active.id, overId: over.id })}`;
-        }
-        return `${t("sortable.list.drag.nolonger.over", { activeId: active.id })}`;
-      },
-      onDragEnd: ({ active, over }) => {
-        if (over) {
-          return `${t("sortable.list.drag.end.dropped.over", { activeId: active.id, overId: over.id })}`;
-        }
-        return `${t("sortable.list.drag.end.dropped", { activeId: active.id })}`;
-      },
-      onDragCancel: ({ active }) => {
-        return `${t("sortable.list.drag.cancel", { activeId: active.id })}`;
-      },
-    }),
-    [t],
-  );
-
-  return (
-    <DndContext
-      accessibility={{ announcements: announcements }}
-      sensors={sensors}
-      onDragStart={({ active }) => {
-        setActive(active);
-      }}
-      onDragEnd={({ active, over }) => {
-        if (over && active.id !== over?.id) {
-          const activeIndex = items.findIndex(({ id }) => id === active.id);
-          const overIndex = items.findIndex(({ id }) => id === over.id);
-          // allow sorting by default except when isSortable is set to false explicitly
-          if (items[overIndex].isSortable !== false) {
-            onChange(parentId, active.id, activeIndex, overIndex);
-          }
-        }
-        setActive(null);
-      }}
-      onDragCancel={() => {
-        setActive(null);
-      }}
-    >
-      <SortableContext items={items}>
-        {items.map((item) => (
-          <Fragment key={item.id}>{renderItem(item)}</Fragment>
-        ))}
-      </SortableContext>
-      <SortableOverlay>
-        {activeItem ? renderItem(activeItem) : null}
-      </SortableOverlay>
-    </DndContext>
-  );
-};
-
-SortableList.Item = SortableItem;

package/src/ui-shell/SideNav/SortableList/SortableOverlay.tsx

@@ -1,34 +0,0 @@
-/*!
- * Copyright (c) 2024-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-import {
-  defaultDropAnimationSideEffects,
-  DragOverlay,
-  DropAnimation,
-} from "@dnd-kit/core";
-import type { PropsWithChildren } from "react";
-
-const dropAnimationConfig: DropAnimation = {
-  sideEffects: defaultDropAnimationSideEffects({
-    styles: {
-      active: {
-        opacity: "0.4",
-      },
-    },
-  }),
-};
-
-export function SortableOverlay({ children }: PropsWithChildren<object>) {
-  return (
-    <DragOverlay dropAnimation={dropAnimationConfig}>{children}</DragOverlay>
-  );
-}

package/src/ui-shell/SideNav/index.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) 2024-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-export { SideNav } from "./SideNav.js";
-export * from "./NavAccordion.js";
-
-export * from "./types.js";

package/src/ui-shell/SideNav/types.ts

@@ -1,224 +0,0 @@
-/*!
- * Copyright (c) 2024-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-import type { ReactElement, SyntheticEvent } from "react";
-
-import type { HtmlProps } from "../../HtmlProps.js";
-import type { statusSeverityValues } from "../../Status.js";
-import { UniqueIdentifier } from "@dnd-kit/core";
-
-type LogoWithLink = {
-  href: string;
-  ariaLabel: string;
-};
-type LogoWithNoLink = {
-  href?: never;
-  ariaLabel?: never;
-};
-
-export type SideNavLogoProps = { isSameBackgroundAsMain?: boolean } & (
-  | LogoWithLink
-  | LogoWithNoLink
-) &
-  (
-    | {
-        /**
-         * a component to render as the logo
-         */
-        logoComponent: ReactElement;
-        imageAltText?: never;
-        imageUrl?: never;
-      }
-    | {
-        /**
-         * The src url to render in an `img` tag
-         */
-        imageUrl: string;
-        /**
-         * alt text for the img logo
-         */
-        imageAltText: string;
-        logoComponent?: never;
-      }
-    | {
-        /**
-         * The src url to render in an `img` tag
-         */
-        imageUrl?: never;
-        /**
-         * alt text for the img logo
-         */
-        imageAltText?: never;
-        logoComponent?: never;
-      }
-  );
-
-export type SideNavProps = {
-  /**
-   * Side Nav header text that is usually reserved to show the App name
-   */
-  appName?: string;
-  /**
-   *  Determines whether the side nav is collapsible
-   */
-  isCollapsible?: boolean;
-  /**
-   *  Determines whether the side nav is collapsed
-   */
-  isCollapsed?: boolean;
-  /**
-   *  Determines whether the side nav items use compact layout
-   */
-  isCompact?: boolean;
-  /**
-   *  Before the side nav has items, it will be in a loading state.
-   */
-  isLoading?: boolean;
-  /**
-   * An optional logo component or src string for an img to display in the header. If not provided, will default to the Okta logo
-   */
-  logoProps?: SideNavLogoProps;
-  /**
-   *  Triggers when the side nav is collapsed
-   */
-  onCollapse?: () => void;
-  /**
-   *  Triggers when the side nav is expanded
-   */
-  onExpand?: () => void;
-  /**
-   *  Triggers when the item is reordered
-   */
-  onSort?: (
-    reorderedItems: SideNavItem[],
-    parentId: string,
-    activeId: UniqueIdentifier,
-    activeIndex: number,
-    overIndex: number,
-  ) => void;
-  /**
-   * Nav items in the side nav
-   */
-  sideNavItems: SideNavItem[];
-} & (
-  | {
-      /**
-       * The component to display as the footer; if present the `footerItems` are ignored and not rendered.
-       */
-      footerComponent?: ReactElement;
-      footerItems?: never;
-      hasCustomFooter: true;
-    }
-  | {
-      footerComponent?: never;
-      /**
-       * Footer items in the side nav
-       */
-      footerItems?: SideNavFooterItem[];
-      hasCustomFooter?: false;
-    }
-) &
-  Pick<HtmlProps, "testId">;
-
-export type SideNavItem = {
-  /**
-   * The number to display as a count alongside the nav item
-   */
-  count?: number;
-  /**
-   * The icon element to display after the nav item text. Only use this with images that don't have React context. Even the official Odyssey Icons use MUI which references the MUI theme in context and will error when rendered in Unified UI Shell.
-   */
-  endIcon?: ReactElement;
-  id: string;
-  /**
-   * Whether the item is disabled. When set to true the nav item is set to Disabled color,
-   * the link/item is not clickable, and item with nestedNavItems is not expandable.
-   */
-  isDisabled?: boolean;
-  /**
-   * Whether the item is active/selected
-   */
-  isSelected?: boolean;
-  /**
-   * Whether the item is sortable within a sortable list
-   */
-  isSortable?: boolean;
-  label: string;
-  /**
-   * Event fired when the nav item is clicked
-   */
-  onClick?: (event: SyntheticEvent) => void;
-  /**
-   * The status element to display after the label
-   */
-  severity?: (typeof statusSeverityValues)[number];
-  /**
-   * The icon element to display before the nav item text. Only use this with images that don't have React context. Even the official Odyssey Icons use MUI which references the MUI theme in context and will error when rendered in Unified UI Shell.
-   */
-  startIcon?: ReactElement;
-  /**
-   * The label to display inside the status
-   */
-  statusLabel?: string;
-  /**
-   * The link target prop. e.g., "_blank"
-   */
-  target?: string;
-} & (
-  | {
-      nestedNavItems?: never;
-      href?: never;
-      isDefaultExpanded?: never;
-      isExpanded?: never;
-      /**
-       * Determines if the side nav item is a section header
-       */
-      isSectionHeader: true;
-    }
-  | {
-      nestedNavItems?: never;
-      /**
-       * link added to the nav item. if it is undefined, static text will be displayed.
-       * fires onClick event when it is passed
-       */
-      href?: string;
-      isDefaultExpanded?: never;
-      isExpanded?: never;
-      isSectionHeader?: never;
-    }
-  | {
-      /**
-       * An array of side nav items to be displayed as nestedNavItems within Accordion
-       */
-      nestedNavItems: Array<Omit<SideNavItem, "nestedNavItems" | "startIcon">>;
-      href?: never;
-      /**
-       * Whether the accordion (nav item with nestedNavItems) is expanded by default
-       */
-      isDefaultExpanded?: boolean;
-      /**
-       * If true, expands the accordion, otherwise collapse it.
-       * Setting this prop enables control over the accordion.
-       */
-      isExpanded?: boolean;
-      /**
-       * If true, enables sorting for the accordion items
-       */
-      isSectionHeader?: never;
-    }
-);
-
-export type SideNavFooterItem = {
-  href?: string;
-  id: string;
-  label: string;
-};

package/src/ui-shell/TopNav/TopNav.tsx

@@ -1,109 +0,0 @@
-/*!
- * Copyright (c) 2022-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-import styled from "@emotion/styled";
-import { memo, type ReactElement } from "react";
-
-import type { HtmlProps } from "../../HtmlProps.js";
-import {
-  DesignTokens,
-  useOdysseyDesignTokens,
-} from "../../OdysseyDesignTokensContext.js";
-import {
-  UiShellColors,
-  useUiShellContext,
-} from "../../ui-shell/UiShellProvider.js";
-
-export const TOP_NAV_HEIGHT = `${64 / 14}rem`;
-
-const StyledLeftSideContainer = styled("div")(() => ({
-  flexGrow: 1,
-}));
-
-const StyledRightSideContainer = styled("div")(() => ({
-  flexShrink: 0,
-}));
-
-const StyledTopNavContainer = styled("div", {
-  shouldForwardProp: (prop) =>
-    prop !== "odysseyDesignTokens" &&
-    prop !== "isScrolled" &&
-    prop !== "topNavBackgroundColor",
-})<{
-  isScrolled?: boolean;
-  odysseyDesignTokens: DesignTokens;
-  topNavBackgroundColor?: UiShellColors["topNavBackgroundColor"];
-}>(({ odysseyDesignTokens, isScrolled, topNavBackgroundColor }) => ({
-  alignItems: "center",
-  backgroundColor: topNavBackgroundColor,
-  boxShadow: isScrolled ? odysseyDesignTokens.DepthMedium : undefined,
-  clipPath: "inset(0 0 -100vh 0)",
-  display: "flex",
-  gap: odysseyDesignTokens.Spacing4,
-  height: "100%",
-  justifyContent: "space-between",
-  maxHeight: TOP_NAV_HEIGHT,
-  minHeight: TOP_NAV_HEIGHT,
-  paddingBlock: odysseyDesignTokens.Spacing2,
-  paddingInline: odysseyDesignTokens.Spacing8,
-  position: "relative",
-  transition: `box-shadow ${odysseyDesignTokens.TransitionDurationMain} ${odysseyDesignTokens.TransitionTimingMain}`,
-  zIndex: 100,
-
-  ...(topNavBackgroundColor === odysseyDesignTokens.HueNeutralWhite && {
-    borderBottom: `${odysseyDesignTokens.BorderWidthMain} ${odysseyDesignTokens.BorderStyleMain} ${odysseyDesignTokens.HueNeutral100}`,
-  }),
-}));
-
-export type TopNavProps = {
-  /**
-   * Whether or not the underlying content has been scrolled
-   */
-  isScrolled?: boolean;
-  /**
-   * React components that render into the left side of the top nav.
-   */
-  leftSideComponent?: ReactElement;
-  /**
-   * React components that render into the right side of the top nav.
-   */
-  rightSideComponent?: ReactElement;
-} & Pick<HtmlProps, "testId">;
-
-const TopNav = ({
-  isScrolled,
-  leftSideComponent,
-  rightSideComponent,
-}: TopNavProps) => {
-  const odysseyDesignTokens = useOdysseyDesignTokens();
-  const uiShellContext = useUiShellContext();
-
-  return (
-    <StyledTopNavContainer
-      odysseyDesignTokens={odysseyDesignTokens}
-      isScrolled={isScrolled}
-      topNavBackgroundColor={uiShellContext?.topNavBackgroundColor}
-    >
-      <StyledLeftSideContainer>
-        {leftSideComponent ?? <div />}
-      </StyledLeftSideContainer>
-      <StyledRightSideContainer>
-        {rightSideComponent ?? <div />}
-      </StyledRightSideContainer>
-    </StyledTopNavContainer>
-  );
-};
-
-const MemoizedTopNav = memo(TopNav);
-MemoizedTopNav.displayName = "TopNav";
-
-export { MemoizedTopNav as TopNav };

package/src/ui-shell/TopNav/TopNavLinksList.tsx

@@ -1,68 +0,0 @@
-/*!
- * Copyright (c) 2022-present, Okta, Inc. and/or its affiliates. All rights reserved.
- * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and limitations under the License.
- */
-
-import styled from "@emotion/styled";
-import { memo, type ReactElement } from "react";
-
-import type { HtmlProps } from "../../HtmlProps.js";
-import { TopNavListItem, TopNavListItemProps } from "./TopNavListItem.js";
-import { UserProfileProps } from "../../labs/UserProfile.js";
-
-export type TopNavLinksListProps = {
-  /**
-   * Pass in an additional component like `Button` that will be displayed after the nav link items
-   */
-  additionalNavItem?: ReactElement;
-  /**
-   * URL to the help page.
-   */
-  helpPageHref?: string;
-  /**
-   *  Pass in a SearchField component with the variant="filled" prop set
-   */
-  searchField?: ReactElement;
-  /**
-   * URL to settings page.
-   */
-  settingsPageHref?: string;
-  /**
-   * Nav links in the top nav
-   */
-  topNavLinkItems: TopNavListItemProps[];
-  /**
-   * Displays user account info
-   */
-  userProfile?: UserProfileProps;
-} & Pick<HtmlProps, "testId">;
-
-const StyledTopNavList = styled("ul")(() => ({
-  alignItems: "center",
-  display: "flex",
-  listStyle: "none",
-  listStyleType: "none",
-  padding: 0,
-}));
-
-const TopNavLinksList = ({ topNavLinkItems }: TopNavLinksListProps) => (
-  <nav>
-    <StyledTopNavList>
-      {topNavLinkItems.map((item) => (
-        <TopNavListItem {...item} key={item.id} />
-      ))}
-    </StyledTopNavList>
-  </nav>
-);
-
-const MemoizedTopNavLinksList = memo(TopNavLinksList);
-MemoizedTopNavLinksList.displayName = "TopNavLinksList";
-
-export { MemoizedTopNavLinksList as TopNavLinksList };