Skip to content

Commit

Permalink
Add comment to Filters
Browse files Browse the repository at this point in the history
  • Loading branch information
codytodonnell committed Aug 2, 2024
1 parent 5ca5331 commit 6c37f13
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion strudel-components/lib/components/Filters.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import React, { useEffect, useState } from 'react';
import { FilterContext, FilterState } from './FilterContext';
import { hasValue } from './FilterField';


interface FilterPanelProps extends PaperProps {
onChange?: (filters: FilterState['activeFilters']) => void;
onClose?: () => any;
Expand All @@ -13,6 +12,11 @@ interface FilterPanelProps extends PaperProps {
grouped?: boolean;
}

/**
* Container panel for FilterField(s) and FilterGroup(s).
* Acts as a multi-dimensional input where you can monitor
* the active state of all filters contained inside the component.
*/
export const Filters: React.FC<FilterPanelProps> = ({
header = 'Filters',
grouped = true,
Expand Down

0 comments on commit 6c37f13

Please sign in to comment.