Skip to content

An open source design system that's fully customizable and agent ready

TypeScript
1.0 KB
Raw Blame
// Copyright (c) Meta Platforms, Inc. and affiliates.

'use client';

/**
 * @file TokenizerItemRemovableContext.ts
 * @input None
 * @output A context carrying a predicate that tells which tokens the user can
 *   remove
 * @position Internal to Core: not exported from the Tokenizer barrel. A
 *   component that composes Tokenizer and locks some tokens (PowerSearch: its
 *   read-only filters, and every filter of a read-only field) provides it. In
 *   the popover presentation, Clear all then keeps a locked token, Backspace
 *   removes nothing while the last token is locked, and Clear all shows only
 *   while a removable token remains. Without it, every token is removable.
 */

import type {SearchableItem} from '../Typeahead/types';
import {createSharedContext} from '../utils/sharedContext';

export const TokenizerItemRemovableContext = createSharedContext<
  ((item: SearchableItem) => boolean) | null
>('TokenizerItemRemovableContext', 1, null);
TokenizerItemRemovableContext.displayName = 'TokenizerItemRemovableContext';