@redocly/theme 0.59.0-next.0 → 0.59.0-next.2

package/src/components/Catalog/CatalogFilter/CatalogFilter.tsx

@@ -0,0 +1,56 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import type { JSX } from 'react';
+import type { FilterProps, FilterTypes } from '@redocly/theme/core/types';
+
+import { CatalogFilterSelect } from '@redocly/theme/components/Catalog/CatalogFilter/CatalogFilterSelect';
+import { CatalogFilterCheckboxes } from '@redocly/theme/components/Catalog/CatalogFilter/CatalogFilterCheckboxes';
+import { CatalogFilterDateRange } from '@redocly/theme/components/Catalog/CatalogFilter/CatalogFilterDateRange';
+
+const filterComponents = {
+  select: CatalogFilterSelect,
+  'date-range': CatalogFilterDateRange,
+  checkboxes: CatalogFilterCheckboxes,
+} as const;
+
+export type CatalogFilterProps = FilterProps & {
+  className?: string;
+};
+
+export function CatalogFilter({
+  filter,
+  filterValuesCasing,
+  showCounter = true,
+  className,
+}: CatalogFilterProps): JSX.Element | null {
+  if (!filter.parentUsed) return null;
+
+  const FilterComponent = filterComponents[(filter.type || 'checkboxes') as FilterTypes];
+
+  return (
+    <CatalogFilterGroup
+      className={className}
+      data-component-name="Catalog/CatalogFilter"
+      key={filter.property + filter.title}
+    >
+      <FilterComponent
+        filter={filter}
+        filterValuesCasing={filterValuesCasing}
+        showCounter={showCounter}
+      />
+    </CatalogFilterGroup>
+  );
+}
+
+const CatalogFilterGroup = styled.div`
+  padding: var(--filter-group-padding);
+  display: flex;
+  flex-direction: column;
+  gap: var(--filter-group-gap);
+  border-bottom: 1px solid var(--catalog-table-border-color);
+
+  &:first-child {
+    border-top: 1px solid var(--catalog-table-border-color);
+  }
+`;

package/src/components/Catalog/CatalogFilter/CatalogFilterCheckboxes.tsx

@@ -0,0 +1,169 @@
+import React, { useState, useMemo } from 'react';
+import styled from 'styled-components';
+import { findAll } from 'highlight-words-core';
+
+import type { JSX } from 'react';
+import type { FilterProps } from '@redocly/theme/core/types';
+
+import { FilterOptions } from '@redocly/theme/components/Filter/FilterOptions';
+import { FilterOption } from '@redocly/theme/components/Filter/FilterOption';
+import { FilterOptionLabel } from '@redocly/theme/components/Filter/FilterOptionLabel';
+import { FilterInput } from '@redocly/theme/components/Filter/FilterInput';
+import { useThemeHooks } from '@redocly/theme/core/hooks';
+import { CheckboxIcon } from '@redocly/theme/icons/CheckboxIcon/CheckboxIcon';
+import { CounterTag } from '@redocly/theme/components/Tags/CounterTag';
+import { changeTextCasing } from '@redocly/theme/core/utils';
+import { Accordion } from '@redocly/theme/components/Accordion/Accordion';
+
+export type CatalogFilterCheckboxesProps = FilterProps & {
+  className?: string;
+};
+
+export function CatalogFilterCheckboxes({
+  filter,
+  filterValuesCasing,
+  showCounter = true,
+  className,
+}: CatalogFilterCheckboxesProps): JSX.Element {
+  const { useTranslate, useTelemetry } = useThemeHooks();
+  const { translate } = useTranslate();
+  const telemetry = useTelemetry();
+
+  const [searchTerm, setSearchTerm] = useState('');
+  const [isExpanded, setIsExpanded] = useState(false);
+
+  const filteredOptions = useMemo(() => {
+    const options = filter.filteredOptions || filter.options;
+    if (!searchTerm.trim()) return options;
+
+    const lowerSearchTerm = searchTerm.toLowerCase();
+    return options.filter(({ value }) => {
+      const translatedValue = changeTextCasing(translate(value), filterValuesCasing);
+      if (!translatedValue) return false;
+      return translatedValue.toLowerCase().includes(lowerSearchTerm);
+    });
+  }, [searchTerm, filter.filteredOptions, filter.options, translate, filterValuesCasing]);
+
+  const selectedCount = useMemo(() => {
+    if (filter.selectedOptions instanceof Set) {
+      return filter.selectedOptions.size;
+    }
+    return 0;
+  }, [filter.selectedOptions]);
+
+  const highlightText = (text: string): JSX.Element => {
+    if (!searchTerm.trim()) {
+      return <>{text}</>;
+    }
+
+    const chunks = findAll({
+      searchWords: [searchTerm],
+      textToHighlight: text,
+    });
+
+    return (
+      <>
+        {chunks.map((chunk, idx) => {
+          const { end, highlight, start } = chunk;
+          const chunkText = text.substr(start, end - start);
+          if (highlight) {
+            return <HighlightedText key={idx}>{chunkText}</HighlightedText>;
+          } else {
+            return <span key={idx}>{chunkText}</span>;
+          }
+        })}
+      </>
+    );
+  };
+
+  const headerContent = (
+    <AccordionHeaderContent>
+      <span>{translate(filter.titleTranslationKey, filter.title)}</span>
+      {selectedCount > 0 && <CounterTag borderless>{selectedCount}</CounterTag>}
+    </AccordionHeaderContent>
+  );
+
+  return (
+    <AccordionWrapper
+      className={className}
+      $hasSelection={selectedCount > 0 && !isExpanded}
+      data-component-name="Catalog/CatalogFilterCheckboxes"
+    >
+      <Accordion expanded={isExpanded} header={headerContent} onToggle={setIsExpanded}>
+        <FilterSearchWrapper>
+          <FilterInput value={searchTerm} onChange={setSearchTerm} />
+        </FilterSearchWrapper>
+        <FilterOptions>
+          {filteredOptions.map(({ value, count }) => {
+            const id = 'filter--' + filter.property + '--' + value;
+            return (
+              <FilterCheckboxOption
+                key={id}
+                role="link"
+                onClick={() => {
+                  filter.toggleOption(value);
+                  telemetry.sendFilterCheckboxToggledMessage({ id });
+                }}
+              >
+                <CheckboxIcon
+                  checked={
+                    filter.selectedOptions instanceof Set
+                      ? filter.selectedOptions.has(value) ||
+                        filter.selectedOptions.has(value?.toLowerCase())
+                      : false
+                  }
+                />
+                <FilterOptionLabel data-translation-key={value}>
+                  {highlightText(changeTextCasing(translate(value), filterValuesCasing) || '')}
+                </FilterOptionLabel>
+                {showCounter && <CounterTag borderless>{count}</CounterTag>}
+              </FilterCheckboxOption>
+            );
+          })}
+        </FilterOptions>
+      </Accordion>
+    </AccordionWrapper>
+  );
+}
+
+const AccordionWrapper = styled.div<{ $hasSelection: boolean }>`
+  position: relative;
+  border-right: 4px solid transparent;
+
+  ${({ $hasSelection }) =>
+    $hasSelection &&
+    `
+    border-right-color: var(--color-blueberry-6);
+    
+    &::after {
+      content: '';
+      position: absolute;
+      bottom: -1px;
+      right: -4px;
+      width: 4px;
+      height: 1px;
+      background-color: var(--color-blueberry-6);
+      z-index: 1;
+    }
+  `}
+`;
+
+const AccordionHeaderContent = styled.div`
+  display: flex;
+  align-items: center;
+  gap: var(--spacing-xs);
+  width: 100%;
+`;
+
+const HighlightedText = styled.span`
+  background-color: var(--catalog-highlight-bg-color);
+  color: var(--catalog-highlight-text-color);
+`;
+
+const FilterCheckboxOption = styled(FilterOption)`
+  padding-left: var(--filter-option-checkbox-padding-left);
+`;
+
+const FilterSearchWrapper = styled.div`
+  padding: var(--filter-content-search-padding);
+`;

package/src/components/Catalog/CatalogFilter/CatalogFilterContent.tsx

@@ -0,0 +1,121 @@
+import React from 'react';
+import styled, { css } from 'styled-components';
+
+import type { JSX } from 'react';
+import type { ResolvedFilter } from '@redocly/theme/core/types';
+import type { RedoclyConfig } from '@redocly/theme/config';
+
+import { FilterInput } from '@redocly/theme/components/Filter/FilterInput';
+import { useThemeHooks } from '@redocly/theme/core/hooks';
+import { Button } from '@redocly/theme/components/Button/Button';
+import { CatalogFilter } from '@redocly/theme/components/Catalog/CatalogFilter/CatalogFilter';
+import { isFromToSelectedOptions } from '@redocly/theme/core/utils';
+
+export type CatalogFilterContentProps = {
+  setFilterTerm: (value: string) => void;
+  filters: ResolvedFilter[];
+  filterTerm: string;
+  filterValuesCasing?:
+    | NonNullable<RedoclyConfig['catalog']>[string]['filterValuesCasing']
+    | ((str: string) => string);
+  hideSearch?: boolean;
+  showCounter?: boolean;
+  className?: string;
+};
+
+export function CatalogFilterContent({
+  setFilterTerm,
+  filters,
+  filterTerm,
+  filterValuesCasing,
+  hideSearch,
+  showCounter = true,
+  className,
+}: CatalogFilterContentProps): JSX.Element | null {
+  const { useTranslate } = useThemeHooks();
+  const { translate } = useTranslate();
+
+  const hasActiveFilters = filters.some((filter) => {
+    if (filterTerm) return true;
+    if (filter.selectedOptions && filter.selectedOptions instanceof Set) {
+      return filter.selectedOptions.size;
+    } else if (
+      isFromToSelectedOptions(filter.selectedOptions) &&
+      filter.selectedOptions.from &&
+      filter.selectedOptions.to
+    ) {
+      return true;
+    }
+  });
+
+  const handleClearAll = (): void => {
+    filters.forEach((filter) => filter.selectOption(''));
+    setFilterTerm('');
+  };
+
+  if (!filters.length) {
+    return null;
+  }
+
+  return (
+    <CatalogFilterContentWrapper
+      className={className}
+      data-component-name="Catalog/CatalogFilterContent"
+    >
+      <FiltersHeader>
+        <FiltersTitle data-translation-key="catalog.filters.title">
+          {translate('catalog.filters.title', 'Filters')}
+        </FiltersTitle>
+        {hasActiveFilters ? (
+          <Button size="medium" tone="danger" variant="ghost" onClick={handleClearAll}>
+            {translate('catalog.filters.clearAll', 'Clear filters')}
+          </Button>
+        ) : null}
+      </FiltersHeader>
+      {!hideSearch && (
+        <FilterInput value={filterTerm} onChange={(updatedTerm) => setFilterTerm(updatedTerm)} />
+      )}
+      <FilterItems hideSearch={hideSearch}>
+        {filters.map((filter, idx) => (
+          <CatalogFilter
+            filter={filter}
+            key={filter.property + '-' + idx}
+            filterValuesCasing={filterValuesCasing}
+            showCounter={showCounter}
+          />
+        ))}
+      </FilterItems>
+    </CatalogFilterContentWrapper>
+  );
+}
+
+const CatalogFilterContentWrapper = styled.div`
+  padding: 0 0 var(--filter-content-padding-vertical) 0;
+  display: flex;
+  flex-direction: column;
+`;
+
+const FiltersHeader = styled.div`
+  display: flex;
+  padding: var(--filter-content-header-padding-vertical)
+    var(--filter-content-header-padding-horizontal);
+`;
+
+const FiltersTitle = styled.div`
+  margin-right: auto;
+  font-size: var(--filter-content-title-font-size);
+  font-weight: var(--filter-content-title-font-weight);
+  line-height: var(--filter-content-title-line-height);
+`;
+
+const FilterItems = styled.div<{ hideSearch?: boolean }>`
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+  border-top: 1px solid var(--border-color-secondary);
+  ${({ hideSearch }) =>
+    hideSearch &&
+    css`
+      border-top: none;
+    `}
+`;

package/src/components/Catalog/CatalogFilter/CatalogFilterDateRange.tsx

@@ -0,0 +1,147 @@
+import React, { useMemo } from 'react';
+import styled from 'styled-components';
+
+import type { JSX } from 'react';
+import type { FilterProps } from '@redocly/theme/core/types';
+
+import { FilterOptions } from '@redocly/theme/components/Filter/FilterOptions';
+import { DatePicker } from '@redocly/theme/components/DatePicker/DatePicker';
+import { CounterTag } from '@redocly/theme/components/Tags/CounterTag';
+import { useThemeHooks } from '@redocly/theme/core/hooks';
+import { formatDateWithoutTimeZone } from '@redocly/theme/core/utils';
+import { Accordion } from '@redocly/theme/components/Accordion/Accordion';
+
+export type CatalogFilterDateRangeProps = FilterProps & {
+  className?: string;
+};
+
+export function CatalogFilterDateRange({
+  filter,
+  className,
+}: CatalogFilterDateRangeProps): JSX.Element {
+  const { useTranslate } = useThemeHooks();
+  const { translate } = useTranslate();
+
+  const from = useMemo(
+    () => (filter.selectedOptions.from ? new Date(filter.selectedOptions.from) : undefined),
+    [filter.selectedOptions.from],
+  );
+  const to = useMemo(
+    () => (filter.selectedOptions.to ? new Date(filter.selectedOptions.to) : undefined),
+    [filter.selectedOptions.to],
+  );
+
+  const selectedCount = useMemo(() => {
+    return from && to ? 1 : 0;
+  }, [from, to]);
+
+  const headerContent = (
+    <AccordionHeaderContent>
+      <span>{translate(filter.titleTranslationKey, filter.title)}</span>
+      {selectedCount > 0 && <CounterTag borderless>{selectedCount}</CounterTag>}
+    </AccordionHeaderContent>
+  );
+
+  return (
+    <AccordionWrapper
+      className={className}
+      $hasSelection={selectedCount > 0}
+      data-component-name="Catalog/CatalogFilterDateRange"
+    >
+      <Accordion expanded={false} header={headerContent}>
+        <FilterOptions>
+          <DateRangeWrapper>
+            <DateRangeRow>
+              <span>From:</span>
+              <DatePicker
+                closeCalendar={true}
+                format="y-MM-dd"
+                dayPlaceholder="DD"
+                monthPlaceholder="MM"
+                yearPlaceholder="YYYY"
+                value={from}
+                maxDate={new Date()}
+                onChange={(from) => {
+                  if (Array.isArray(from)) return;
+                  filter.selectOption({
+                    ...filter.selectedOptions,
+                    from: formatDateWithoutTimeZone(from),
+                    to: formatDateWithoutTimeZone(to),
+                  });
+                }}
+              />
+            </DateRangeRow>
+            <DateRangeRow>
+              <span>To:</span>
+              <DatePicker
+                closeCalendar={true}
+                dayPlaceholder="DD"
+                monthPlaceholder="MM"
+                yearPlaceholder="YYYY"
+                format="y-MM-dd"
+                minDate={from}
+                value={to}
+                onChange={(to) => {
+                  if (Array.isArray(to)) return;
+                  filter.selectOption({
+                    ...filter.selectedOptions,
+                    from: formatDateWithoutTimeZone(from),
+                    to: formatDateWithoutTimeZone(to),
+                  });
+                }}
+              />
+            </DateRangeRow>
+          </DateRangeWrapper>
+        </FilterOptions>
+      </Accordion>
+    </AccordionWrapper>
+  );
+}
+
+const AccordionWrapper = styled.div<{ $hasSelection: boolean }>`
+  position: relative;
+  border-right: 4px solid transparent;
+
+  ${({ $hasSelection }) =>
+    $hasSelection &&
+    `border-right-color: var(--color-blueberry-6);
+    
+    &::after {
+      content: '';
+      position: absolute;
+      bottom: -1px;
+      right: -4px;
+      width: 4px;
+      height: 1px;
+      background-color: var(--color-blueberry-6);
+      z-index: 1;
+    }
+  `}
+`;
+
+const AccordionHeaderContent = styled.div`
+  display: flex;
+  align-items: center;
+  gap: var(--spacing-xs);
+  width: 100%;
+`;
+
+const DateRangeWrapper = styled.div`
+  display: flex;
+  flex-direction: column;
+  gap: var(--filter-options-gap);
+`;
+
+const DateRangeRow = styled.div`
+  color: var(--filter-date-picker-color);
+  display: flex;
+  flex-direction: row;
+
+  align-items: center;
+  gap: var(--filter-date-picker-gap);
+
+  > span {
+    width: var(--filter-date-picker-width);
+    color: var(--filter-option-label-color);
+  }
+`;

package/src/components/Catalog/CatalogFilter/CatalogFilterSelect.tsx

@@ -0,0 +1,136 @@
+import React, { useMemo, useState } from 'react';
+import styled from 'styled-components';
+
+import type { JSX } from 'react';
+import type { FilterProps, SelectProps, SelectOption } from '@redocly/theme/core/types';
+
+import { FilterOption } from '@redocly/theme/components/Filter/FilterOption';
+import { FilterOptionLabel } from '@redocly/theme/components/Filter/FilterOptionLabel';
+import { Select } from '@redocly/theme/components/Select/Select';
+import { CounterTag } from '@redocly/theme/components/Tags/CounterTag';
+import { changeTextCasing } from '@redocly/theme/core/utils';
+import { useThemeHooks } from '@redocly/theme/core/hooks';
+import { Accordion } from '@redocly/theme/components/Accordion/Accordion';
+
+export type CatalogFilterSelectProps = FilterProps & {
+  className?: string;
+};
+
+export function CatalogFilterSelect({
+  filter,
+  filterValuesCasing,
+  showCounter = true,
+  className,
+}: CatalogFilterSelectProps): JSX.Element {
+  const { useTranslate } = useThemeHooks();
+  const { translate } = useTranslate();
+  const [isExpanded, setIsExpanded] = useState(false);
+
+  const selectedCount = useMemo(() => {
+    if (filter.selectedOptions instanceof Set) {
+      const firstValue = filter.selectedOptions.values().next()?.value;
+
+      return firstValue && firstValue !== '' ? 1 : 0;
+    }
+    return 0;
+  }, [filter.selectedOptions]);
+
+  let selectOptions: SelectOption<string>[] = [];
+
+  const defaultOptionCount = filter.options.reduce((acc, option) => acc + option.count, 0);
+
+  selectOptions = [
+    {
+      value: '',
+      element: (
+        <FilterOption key="all" onClick={() => filter.selectOption('')}>
+          <FilterOptionLabel data-translation-key="catalog.filters.select.all">
+            {translate('catalog.filters.select.all', 'All')}
+          </FilterOptionLabel>
+          <CounterTag borderless>{defaultOptionCount}</CounterTag>
+        </FilterOption>
+      ),
+    },
+    ...filter.options.map((option) => ({
+      value: option.value,
+      element: (
+        <FilterOption key={option.value}>
+          <FilterOptionLabel data-translation-key={option.value}>
+            {changeTextCasing(translate(option.value), filterValuesCasing)}
+          </FilterOptionLabel>
+          {showCounter && <CounterTag borderless>{option.count}</CounterTag>}
+        </FilterOption>
+      ),
+    })),
+  ];
+
+  const headerContent = (
+    <AccordionHeaderContent>
+      <span>{translate(filter.titleTranslationKey, filter.title)}</span>
+      {selectedCount > 0 && <CounterTag borderless>{selectedCount}</CounterTag>}
+    </AccordionHeaderContent>
+  );
+
+  return (
+    <AccordionWrapper
+      className={className}
+      $hasSelection={selectedCount > 0 && !isExpanded}
+      data-component-name="Catalog/CatalogFilterSelect"
+    >
+      <Accordion expanded={isExpanded} header={headerContent} onToggle={setIsExpanded}>
+        <StyledSelect
+          value={
+            (filter.selectedOptions instanceof Set ? filter.selectedOptions : new Set())
+              .values()
+              .next()?.value || ''
+          }
+          onChange={(value) => filter.selectOption(value)}
+          options={selectOptions}
+        />
+      </Accordion>
+    </AccordionWrapper>
+  );
+}
+
+const AccordionWrapper = styled.div<{ $hasSelection: boolean }>`
+  position: relative;
+  border-right: 4px solid transparent;
+
+  ${({ $hasSelection }) =>
+    $hasSelection &&
+    `border-right-color: var(--color-blueberry-6);
+    
+    &::after {
+      content: '';
+      position: absolute;
+      bottom: -1px;
+      right: -4px;
+      width: 4px;
+      height: 1px;
+      background-color: var(--color-blueberry-6);
+      z-index: 1;
+    }
+  `}
+`;
+
+const AccordionHeaderContent = styled.div`
+  display: flex;
+  align-items: center;
+  gap: var(--spacing-xs);
+  width: 100%;
+`;
+
+const StyledSelect = styled(Select)<SelectProps>`
+  --select-list-max-width: var(--filter-select-max-width);
+
+  min-height: var(--filter-select-min-height);
+  --select-text-color: var(--filter-select-color);
+  border: 1px solid var(--filter-select-border-color);
+  --select-border-radius: var(--filter-select-border-radius);
+  padding: var(--filter-select-padding);
+
+  :hover {
+    border-color: var(--filter-select-border-color-hover);
+  }
+  --filter-option-margin: var(--filter-select-option-margin);
+`;

package/src/components/Catalog/CatalogSelector.tsx

@@ -52,7 +52,6 @@ export function CatalogSelector({
 
 export const CatalogSelectWrapper = styled.div`
   margin-top: var(--catalog-select-wrapper-margin-top);
-  margin-bottom: var(--catalog-select-wrapper-margin-bottom);
 `;
 
 export const CatalogSelectLabel = styled.label`

package/src/components/Catalog/variables.ts

@@ -80,7 +80,6 @@ export const catalog = css`
     * @tokens Catalog selector
     */
   --catalog-select-wrapper-margin-top: var(--spacing-xxs);
-  --catalog-select-wrapper-margin-bottom: var(--spacing-base);
   --catalog-select-label-margin-bottom: var(--spacing-xxs);
   --catalog-select-label-font-weight: var(--filter-title-font-weight);
   --catalog-select-label-font-size: var(--filter-title-font-size);