@redocly/theme 0.0.0-react18-20231120182601

package/src/components/Filter/styledVariables.ts

@@ -0,0 +1,108 @@
+import { css } from 'styled-components';
+
+export const filter = css`
+  /* === Filter === */
+  /**
+  * @tokens Filters
+  */
+  --filter-group-padding: var(--spacing-base) 0 0 0;
+
+  --filter-title-font-weight: var(--font-weight-bold);
+  --filter-title-font-size: var(--font-size-base);
+  --filter-title-margin: 0 0 var(--spacing-xxs) 0;
+
+  --filter-option-font-weight: var(--font-weight-regular);
+  --filter-option-font-size: var(--font-size-base);
+  --filter-option-margin: var(--spacing-xs) 0 0 0;
+
+  --filter-option-label-font-size: var(--font-size-base);
+  --filter-option-label-font-weight: var(--font-weight-regular);
+  --filter-option-label-margin: 0 var(--spacing-xs) 0 0;
+  --filter-option-label-color: var(--text-secondary);
+
+  --filter-option-count-height: 17px;
+  --filter-option-count-color: var(--text-secondary);
+  --filter-option-count-font-size: var(--font-size-sm);
+  --filter-option-count-font-weight: var(--font-weight-regular);
+  --filter-option-count-padding: 0px var(--spacing-xxs);
+  --filter-option-count-border-radius: var(--spacing-sm);
+  --filter-option-count-border: 1px solid var(--border-primary);
+  --filter-option-count-background-color: var(--bg-overlay);
+
+  --filter-content-border-color: var(--border-secondary);
+  --filter-content-items-padding: 0 var(--spacing-lg);
+  --filter-content-clear-button-width: 100%;
+  --filter-controls-background-color: var(--bg-base);
+
+  --filter-popover-background-color: var(--bg-base);
+  --filter-popover-header-padding: var(--mobile-catalog-filter-padding-vertical) var(--mobile-catalog-filter-padding-horizontal);
+  --filter-popover-header-border-color: var(--border-secondary);
+  --filter-popover-header-background-color: var(--navbar-background-color);
+  --filter-popover-header-label-color: var(--navbar-text-color);
+  --filter-popover-header-label-font-size: var(--font-size-lg);
+  --filter-popover-header-label-font-weight: var(--font-weight-bold);
+  --filter-popover-header-button-color: var(--navbar-text-color);
+  --filter-popover-header-button-height: var(--control-height-base);
+  --filter-popover-header-button-font-size: var(--font-size-base);
+  --filter-popover-header-button-font-weight: var(--font-weight-regular);
+
+  --filter-tags-wrapper-padding: var(--spacing-xs) 0 var(--spacing-base) 0;
+  --filter-tag-color: var(--text-primary);
+  --filter-tag-border-radius: var(--spacing-sm);
+  --filter-tag-border-color: var(--border-primary);
+  --filter-tag-background-color: var(--bg-raised);
+  --filter-tag-padding: 0 var(--spacing-xs);
+  --filter-tag-font-size: var(--font-size-sm);
+  --filter-tag-font-weight: var(--font-weight-regular);
+  --filter-tag-margin: 0 var(--spacing-xxs) 0 0;
+  --filter-tag-label-margin: 0 var(--spacing-xxs) 0 0;
+
+  --filter-input-border: 1px solid var(--border-primary);
+  --filter-input-min-width: 200px;
+  --filter-input-padding: var(--input-padding);
+  --filter-input-border-radius: var(--input-border-radius);
+  --filter-input-background-color: var(--input-background-color);
+  --filter-input-color: var(--text-secondary);
+  --filter-input-font-family: var(--font-family-base);
+  --filter-input-font-size: var(--font-size-base);
+  --filter-input-line-height: var(--input-line-height);
+  --filter-input-placeholder-opacity: 1;
+  --filter-input-placeholder-color: var(--text-placeholder);
+  --filter-input-hover-color: var(--text-primary);
+  --filter-input-hover-border: 1px solid var(--border-primary);
+  --filter-input-focus-color: var(--text-primary);
+  --filter-input-focus-border: 1px solid var(--border-primary);
+
+  --filter-add-button-margin: 0 var(--spacing-sm) 0 0;
+  --filter-add-button-padding: 0;
+  --filter-add-button-font-size: var(--font-size-base);
+  --filter-add-button-font-weight: var(--font-weight-regular);
+
+  --filter-select-min-height: var(--control-height-base);
+  --filter-select-color: var(--text-primary);
+  --filter-select-border-color: var(--border-primary);
+  --filter-select-border-radius: calc(var(--spacing-unit) * 1.5);
+  --filter-select-padding: 0;
+  --filter-select-hover-border-color: var(--text-primary);
+  --filter-select-option-margin: 0;
+
+  --filter-date-picker-color: var(--text-primary);
+  --filter-date-picker-margin: 0 0 var(--spacing-xxs) 0;
+  --filter-date-picker-gap: var(--spacing-xs);
+  --filter-date-picker-width: 50px;
+  --filter-date-picker-tile-background: var(--color-blue-2);
+  --filter-date-picker-tile-color: var(--text-primary);
+  --filter-date-picker-tile-hover-background: var(--color-blue-3);
+  --filter-date-picker-tile-hover-color: var(--text-primary);
+  --filter-date-picker-input-width: var(--spacing-md);
+  --filter-date-picker-invalid-input-background: var(--bg-raised);
+  --filter-date-picker-button-padding: var(--spacing-xxs);
+  --filter-date-picker-icon-stroke: var(--text-secondary);
+  --filter-date-picker-icon-width: var(--spacing-sm);
+  --filter-date-picker-hover-icon-stroke: var(--text-primary);
+  --filter-date-picker-wrapper-border-color: var(--border-primary);
+  --filter-date-picker-wrapper-radius: calc(var(--spacing-unit) * 1.5);
+  --filter-date-picker-wrapper-padding: calc(var(--spacing-xxs) / 2) var(--spacing-xs);
+
+  // @tokens End
+`;

package/src/components/Footer/CustomFooter.tsx

@@ -0,0 +1,46 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { CustomFooterNavItem } from '@theme/components/Footer/CustomFooterNavItem';
+import { FooterCopyright } from '@theme/components/Footer/FooterCopyright';
+import type { NavGroupRecord, ResolvedNavItem } from '@theme/types/portal';
+
+interface FooterProps {
+  data: NavGroupRecord;
+  className?: string;
+}
+
+export function CustomFooter({ data, className }: FooterProps): JSX.Element | null {
+  if (!data) {
+    return null;
+  }
+
+  return (
+    <FooterContainer data-component-name="Footer/CustomFooter" className={className}>
+      {(data.links as ResolvedNavItem[]).map((navItem, index) => {
+        return (
+          <CustomFooterNavItem
+            key={`${navItem.label}_${index}`}
+            data-cy={navItem.label}
+            navItem={navItem}
+          />
+        );
+      })}
+      <FooterCopyright copyrightText={data.copyrightText as string} />
+    </FooterContainer>
+  );
+}
+
+const FooterContainer = styled.div`
+  list-style: none;
+  margin: 0;
+  padding: 0;
+  display: block;
+  background-color: var(--footer-background-color);
+  text-align: center;
+  font-family: var(--font-family-base);
+
+  ${({ theme }) => theme.mediaQueries.medium} {
+    display: block;
+  }
+`;

package/src/components/Footer/CustomFooterNavItem.tsx

@@ -0,0 +1,41 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { Link } from '@portal/Link';
+import type { ResolvedNavItem, ResolvedNavLinkItem } from '@theme/types/portal';
+
+interface CustomFooterNavItemProps {
+  navItem: ResolvedNavItem;
+  className?: string;
+}
+
+export function CustomFooterNavItem({ navItem, className }: CustomFooterNavItemProps): JSX.Element {
+  const item = navItem as ResolvedNavLinkItem;
+
+  return (
+    <FooterItem data-component-name="Navbar/NavbarItem" className={className}>
+      <FooterLink to={item.link}>
+        <FooterLabel>{item.label}</FooterLabel>
+      </FooterLink>
+    </FooterItem>
+  );
+}
+
+const FooterItem = styled.li`
+  display: inline-block;
+  text-align: center;
+  line-height: var(--line-height-base);
+  font-size: var(--navbar-font-size);
+  margin: calc(var(--spacing-unit) * 2) calc(var(--spacing-unit) * 3);
+  font-weight: var(--font-weight-regular);
+`;
+
+const FooterLink = styled(Link)`
+  color: var(--footer-text-color);
+  text-decoration: none;
+`;
+
+const FooterLabel = styled.span`
+  cursor: pointer;
+  vertical-align: middle;
+`;

package/src/components/Footer/Footer.tsx

@@ -0,0 +1,78 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { FooterColumns } from '@theme/components/Footer/FooterColumns';
+import { FooterCopyright } from '@theme/components/Footer/FooterCopyright';
+import { isEmptyArray } from '@theme/utils';
+import { useThemeConfig } from '@theme/hooks';
+import type { LogoConfig, ResolvedNavItem } from '@theme/types/portal';
+import { Flex } from '@theme/ui';
+import { LogoContainer, NavbarLogo } from '@theme/components/NavbarLogo';
+
+export function Footer(): JSX.Element | null {
+  const { footer, logo } = useThemeConfig() || {};
+  const { items, copyrightText } = footer || {};
+
+  if (isEmptyArray(items) || footer?.hide) {
+    return null;
+  }
+
+  return (
+    <FooterPresentationalComponent
+      items={items as ResolvedNavItem[]}
+      copyrightText={copyrightText}
+      logo={footer?.logo?.hide ? undefined : logo}
+    />
+  );
+}
+
+interface FooterPresentationalComponentProps {
+  items: ResolvedNavItem[];
+  copyrightText?: string;
+  logo?: LogoConfig;
+  className?: string;
+}
+
+export function FooterPresentationalComponent({
+  items,
+  copyrightText,
+  logo,
+  className,
+}: FooterPresentationalComponentProps): JSX.Element | null {
+  return (
+    <FooterContainer data-component-name="Footer/Footer" className={className}>
+      <ColumnsSection>
+        {logo && <NavbarLogo logo={logo as Pick<LogoConfig, 'image' | 'link' | 'altText'>} />}
+        <FooterColumns columns={items as ResolvedNavItem[]} />
+      </ColumnsSection>
+      {copyrightText && <FooterCopyright copyrightText={copyrightText} />}
+    </FooterContainer>
+  );
+}
+
+const ColumnsSection = styled(Flex)`
+  flex-direction: column;
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    flex-direction: row;
+  }
+`;
+
+const FooterContainer = styled.footer`
+  padding: var(--mobile-footer-padding-vertical) var(--mobile-footer-padding-horizontal);
+  border-top: 1px solid var(--footer-border-color);
+  font-size: var(--footer-font-size);
+  flex-shrink: 0;
+  background-color: var(--footer-background-color);
+  color: var(--footer-text-color);
+  font-weight: var(--footer-font-weight);
+
+  ${LogoContainer} {
+    display: var(--footer-logo-display);
+    margin: 0 var(--footer-logo-margin-right) var(--footer-logo-margin-bottom) 0;
+  }
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    padding: var(--footer-padding-vertical) var(--footer-padding-horizontal);
+  }
+`;

package/src/components/Footer/FooterColumn.tsx

@@ -0,0 +1,151 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { Link } from '@portal/Link';
+import type { ResolvedNavItem } from '@theme/types/portal';
+import { useTranslate } from '@portal/hooks';
+import { Image } from '@theme/components/Image/Image';
+import { telemetry } from '@portal/telemetry';
+import { ExternalIcon } from '@theme/icons';
+
+interface FooterColumnProps {
+  column: ResolvedNavItem;
+  className?: string;
+}
+
+export function FooterColumn({ column, className }: FooterColumnProps): JSX.Element {
+  const { translate } = useTranslate();
+  const { items = [] } = column;
+
+  const iconsOnly = items.every((item) => item.label === item.link && (item.icon || item.srcSet));
+
+  const label = translate(column.labelTranslationKey, column.label);
+  const labelOrLink =
+    column.type === 'link' ? (
+      <Link to={column.link} external={column.external} target={column.target}>
+        {label}
+      </Link>
+    ) : (
+      label
+    );
+
+  return (
+    <FooterColumnContainer data-component-name="Footer/FooterColumn" className={className}>
+      <FooterColumnTitle>{labelOrLink}</FooterColumnTitle>
+      <FooterColumnItems iconsOnly={iconsOnly}>
+        {items?.map((columnItem, columnItemIndex) => {
+          if (columnItem.type === 'error') {
+            return null;
+          }
+
+          return columnItem.type === 'separator' ? (
+            <FooterSeparator key={columnItem.label + '_' + columnItemIndex}>
+              {translate(columnItem.labelTranslationKey, columnItem.label)}
+            </FooterSeparator>
+          ) : (
+            <FooterLink
+              key={columnItemIndex}
+              to={columnItem.link}
+              external={columnItem.external}
+              target={columnItem.target}
+              data-cy={columnItem.label}
+              iconsOnly={iconsOnly}
+              onClick={() => telemetry.send('footer_item_clicked', {})}
+            >
+              {columnItem.icon || columnItem.srcSet ? (
+                <FooterLinkIcon>
+                  <Image src={columnItem.icon} srcSet={columnItem.srcSet} />
+                </FooterLinkIcon>
+              ) : null}
+              {!iconsOnly && translate(columnItem.labelTranslationKey, columnItem.label)}
+              {columnItem.external ? <ExternalIcon /> : null}
+            </FooterLink>
+          );
+        })}
+      </FooterColumnItems>
+    </FooterColumnContainer>
+  );
+}
+
+const FooterColumnTitle = styled.p`
+  display: inline-block;
+  font-weight: var(--footer-title-font-weight);
+  font-size: var(--footer-title-font-size);
+  margin-top: 0;
+  margin-bottom: var(--mobile-footer-title-margin-bottom);
+  color: var(--footer-title-text-color);
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    margin-bottom: var(--footer-title-margin-bottom);
+  }
+
+  a {
+    text-decoration: none;
+    color: var(--footer-title-text-color);
+
+    &:hover {
+      color: var(--footer-title-hover-color);
+    }
+  }
+`;
+
+const FooterSeparator = styled.div`
+  opacity: 0.75;
+  margin: 10px 0 5px 0;
+  font-size: 0.75em;
+  text-transform: uppercase;
+`;
+
+const FooterColumnContainer = styled.div`
+  display: flex;
+  flex-direction: column;
+  text-align: center;
+  word-break: break-word;
+  flex: 1;
+  margin: 0 0 var(--mobile-footer-column-margin-bottom) 0;
+  min-width: var(--footer-column-min-width);
+  align-content: center;
+  flex-wrap: wrap;
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    text-align: left;
+    margin: 0 var(--footer-column-margin-horizontal);
+    border-right: 1px solid var(--footer-dividing-border-color);
+    margin-bottom: var(--footer-column-margin-bottom);
+  }
+`;
+
+export const FooterLinkIcon = styled.div`
+  display: inline-flex;
+  width: var(--footer-item-icon-width);
+  height: var(--footer-item-icon-height);
+  margin-right: var(--footer-item-icon-margin-right);
+  vertical-align: middle;
+  border: 1px solid var(--footer-item-icon-border-color);
+  border-radius: var(--footer-item-icon-border-radius);
+  padding: var(--footer-item-icon-padding);
+`;
+
+const FooterLink = styled(Link)<{ iconsOnly: boolean }>`
+  padding: var(--footer-link-padding-vertical) var(--footer-link-padding-horizontal);
+  color: var(--footer-link-text-color);
+  text-decoration: none;
+  &:hover {
+    color: var(--footer-link-hover-color);
+  }
+
+  &:last-child ${FooterLinkIcon} {
+    margin-right: ${({ iconsOnly }) => (iconsOnly ? '0' : 'var(--footer-item-icon-margin-right)')};
+  }
+`;
+
+export const FooterColumnItems = styled.div<{ iconsOnly: boolean }>`
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: center;
+  flex-direction: ${(props) => (props.iconsOnly ? 'row' : 'column')};
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    justify-content: flex-start;
+  }
+`;

package/src/components/Footer/FooterColumns.tsx

@@ -0,0 +1,56 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { FooterColumn } from '@theme/components/Footer/FooterColumn';
+import type { ResolvedNavItem } from '@theme/types/portal';
+
+interface FooterColumnsProps {
+  columns: ResolvedNavItem[];
+  className?: string;
+}
+
+export function FooterColumns({ columns, className }: FooterColumnsProps): JSX.Element | null {
+  if (!columns?.length) {
+    return null;
+  }
+
+  return (
+    <FooterColumnsContainer data-component-name="Footer/FooterColumns" className={className}>
+      <FooterRow>
+        {columns.map((column, index) => (
+          <FooterColumn key={`${column.label}_${index}`} column={column} />
+        ))}
+      </FooterRow>
+    </FooterColumnsContainer>
+  );
+}
+
+export const FooterColumnsContainer = styled.div`
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  max-width: var(--footer-container-max-width);
+  margin: 0;
+  flex: 1;
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    margin: 0 auto;
+  }
+
+  ${({ theme }) => theme.mediaQueries.print} {
+    color: black;
+    display: none;
+  }
+`;
+
+export const FooterRow = styled.div`
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: flex-start;
+  flex-direction: column;
+
+  ${({ theme }) => theme.mediaQueries.small} {
+    justify-content: space-between;
+    flex-direction: row;
+  }
+`;

package/src/components/Footer/FooterCopyright.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import { LanguagePicker } from '@theme/i18n/LanguagePicker';
+import { useI18n, useTranslate } from '@portal/hooks';
+
+interface FooterCopyrightProps {
+  copyrightText: string;
+  className?: string;
+}
+
+export function FooterCopyright({
+  copyrightText = '',
+  className,
+}: FooterCopyrightProps): JSX.Element | null {
+  const { translate } = useTranslate();
+  const { changeLanguage } = useI18n();
+
+  return copyrightText ? (
+    <Wrapper
+      className={className}
+      data-component-name="Footer/FooterCopyright"
+      data-translation-key="theme.footer.copyrightText"
+    >
+      <Label>{translate('theme.footer.copyrightText', copyrightText)}</Label>
+      <LanguagePicker onChangeLanguage={changeLanguage} placement="top" alignment="end" />
+    </Wrapper>
+  ) : null;
+}
+
+const Wrapper = styled.section`
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  font-size: var(--footer-copyright-font-size);
+  margin-top: var(--footer-copyright-margin-top);
+  background-color: var(--footer-background-color);
+  color: var(--footer-text-color);
+  text-align: var(--footer-copyright-text-align);
+  span {
+    max-width: var(--footer-container-max-width);
+  }
+`;
+
+const Label = styled.div``;

package/src/components/Footer/index.ts

@@ -0,0 +1,5 @@
+export * from '@theme/components/Footer/Footer';
+export * from '@theme/components/Footer/FooterColumn';
+export * from '@theme/components/Footer/FooterColumns';
+export * from '@theme/components/Footer/FooterCopyright';
+export * from '@theme/components/Footer/styledVariables';

package/src/components/Footer/styledVariables.ts

@@ -0,0 +1,58 @@
+import { css } from 'styled-components';
+
+export const footer = css`
+  /**
+    * @tokens Footer
+    */
+  --footer-background-color: var(--bg-raised); // @presenter Color
+  --footer-text-color: var(--text-secondary); // @presenter Color
+  --footer-border-color: var(--border-secondary); // @presenter Color
+
+  --footer-padding-vertical: calc(var(--spacing-unit) * 20); // @presenter Spacing
+  --footer-padding-horizontal: calc(var(--spacing-unit) * 20); // @presenter Spacing
+
+  --footer-font-size: var(--font-size-base); // @presenter FontSize
+  --footer-font-weight: var(--font-weight-regular); // @presenter FontWeight
+
+  --footer-dividing-border-color: var(--footer-border-color); // @presenter Color
+
+  --footer-title-text-color: var(--text-primary); // @presenter Color
+  --footer-title-font-size: var(--font-size-xl); // @presenter FontSize
+  --footer-title-font-weight: var(--font-weight-bold); // @presenter FontWeight
+  --footer-title-margin-bottom: var(--spacing-lg); // @presenter Spacing
+
+  --footer-link-text-color: var(--text-secondary); // @presenter Color
+  --footer-link-hover-color: var(--text-primary); // @presenter Color
+  --footer-link-padding-vertical: var(--spacing-xs); // @presenter Spacing
+  --footer-link-padding-horizontal: 0;
+
+  --footer-item-icon-width: var(--spacing-lg); // @presenter Spacing
+  --footer-item-icon-height: var(--spacing-lg); // @presenter Spacing
+  --footer-item-icon-margin-right: var(--spacing-sm); // @presenter Spacing
+  --footer-item-icon-border-color: var(--border-primary); // @presenter Color
+  --footer-item-icon-border-radius: 12px; // @presenter BorderRadius
+  --footer-item-icon-padding: var(--spacing-xxs); // @presenter Spacing
+
+  --footer-column-min-width: calc(var(--spacing-unit) * 30);
+  --footer-column-margin-bottom: var(--spacing-lg); // @presenter Spacing
+  --footer-column-margin-horizontal: var(--spacing-sm); // @presenter Spacing
+
+  --footer-copyright-font-size: var(--footer-font-size); // @presenter FontSize
+  --footer-copyright-margin-top: var(--spacing-sm); // @presenter Spacing
+  --footer-copyright-text-align: start;
+
+  --footer-logo-display: block;
+  --footer-logo-margin-right: 0; // @presenter Spacing
+  --footer-logo-margin-bottom: var(--spacing-xl); // @presenter Spacing
+
+  --footer-language-picker-display: block;
+
+  --footer-container-max-width: var(--container-width); // @presenter Spacing
+
+  --mobile-footer-padding-vertical: var(--spacing-base); // @presenter Spacing
+  --mobile-footer-padding-horizontal: var(--spacing-base); // @presenter Spacing
+  --mobile-footer-column-margin-bottom: var(--spacing-base); // @presenter Spacing
+  --mobile-footer-title-margin-bottom: var(--spacing-sm); // @presenter Spacing
+
+  // @tokens End
+`;

package/src/components/Image/Image.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import styled from 'styled-components';
+
+function parseSrcSet(srcSet: string): Map<string, string> {
+  const result = new Map<string, string>();
+  const parts = srcSet?.split(', ');
+
+  for (const part of parts) {
+    const [url, theme] = part.split(' ');
+    result.set(theme, url);
+  }
+
+  return result;
+}
+
+type ImageProps = {
+  src?: string;
+  srcSet?: string;
+  alt?: string;
+  className?: string;
+};
+
+export function Image(props: ImageProps) {
+  const { src, srcSet, alt, className } = props;
+
+  const parsedSourceSetMap = React.useMemo(() => {
+    return srcSet ? parseSrcSet(srcSet) : new Map();
+  }, [srcSet]);
+
+  return (
+    <>
+      {src ? (
+        <img src={src} alt={alt} className={className} />
+      ) : (
+        Array.from(parsedSourceSetMap).map(([key, value]) => (
+          <ColorModeAwareImage key={key} colorMode={key} src={value} alt={alt} />
+        ))
+      )}
+    </>
+  );
+}
+
+const ColorModeAwareImage = styled.img<{ colorMode: string }>`
+  html:not(.${(props) => props.colorMode}) && {
+    display: none;
+  }
+`;

package/src/components/Image/index.ts

@@ -0,0 +1 @@
+export * from '@theme/components/Image/Image';