airbnb/caravel

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with 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 { QueryFormData, JsonValue } from '@superset-ui/core';
import { ReactNode } from 'react';

/**
 * Props passed to control components.
 *
 * Ref: superset-frontend/src/explore/components/Control.tsx
 */
export interface ControlComponentProps<
  ValueType extends JsonValue = JsonValue,
> {
  name: string;
  label?: ReactNode;
  description?: ReactNode;
  formData?: QueryFormData | null;
  value?: ValueType | null;
  validationErrors?: any[];
  hidden?: boolean;
  renderTrigger?: boolean;
  hovered?: boolean;
  onChange?: (value: ValueType) => void;
}