@synergy-design-system/react
Version:
React wrappers for the Synergy Design System
67 lines (66 loc) • 3.79 kB
TypeScript
import Component from '@synergy-design-system/components/components/file/file.component.js';
import { type EventName } from '@lit/react';
import type { SynBlurEvent } from '@synergy-design-system/components';
import type { SynChangeEvent } from '@synergy-design-system/components';
import type { SynErrorEvent } from '@synergy-design-system/components';
import type { SynFocusEvent } from '@synergy-design-system/components';
import type { SynInputEvent } from '@synergy-design-system/components';
/**
* @summary File controls allow selecting an arbitrary number of files for uploading.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-file--docs
* @status stable
*
* @dependency syn-button
* @dependency syn-icon
*
* @slot label - The file control's label. Alternatively, you can use the `label` attribute.
* @slot help-text - Text that describes how to use the file control.
* Alternatively, you can use the `help-text` attribute.
* @slot droparea-icon - Optional droparea icon to use instead of the default.
* Works best with `<syn-icon>`.
* @slot trigger - Optional content to be used as trigger instead of the default content.
* Opening the file dialog on click and as well as drag and drop will work for this content.
* Following attributes will no longer work: *label*, *droparea*, *help-text*, *size*,
* *hide-value*. Also if using the disabled attribute, the disabled styling will not be
* applied and must be taken care of yourself.
*
* @event syn-blur - Emitted when the control loses focus.
* @event syn-change - Emitted when an alteration to the control's value is committed by the user.
* @event syn-error - Emitted when multiple files are selected via drag and drop, without
* the `multiple` property being set.
* @event syn-focus - Emitted when the control gains focus.
* @event syn-input - Emitted when the control receives input.
*
* @csspart form-control - The form control that wraps the label, input, and help text.
* @csspart form-control-label - The label's wrapper.
* @csspart form-control-input - The input's wrapper.
* @csspart form-control-help-text - The help text's wrapper.
* @csspart button-wrapper - The wrapper around the button and text value.
* @csspart button - The syn-button acting as a file input.
* @csspart button__base - The syn-button's exported `base` part.
* @csspart value - The chosen files or placeholder text for the file input.
* @csspart droparea - The element wrapping the drop zone.
* @csspart droparea-background - The background of the drop zone.
* @csspart droparea-icon - The container that wraps the icon for the drop zone.
* @csspart droparea-value - The text for the drop zone.
* @csspart trigger - The container that wraps the trigger.
*
* @animation file.iconDrop - The animation to use for the file icon
* when a file is dropped
* @animation file.text.disappear - The disappear animation to use for the file placeholder text
* when a file is dropped
* @animation file.text.appear - The appear animation to use for the file placeholder text
* when a file is dropped
*/
export declare const SynFile: import("@lit/react").ReactWebComponent<Component, {
onSynBlur: EventName<SynBlurEvent>;
onSynChange: EventName<SynChangeEvent>;
onSynError: EventName<SynErrorEvent>;
onSynFocus: EventName<SynFocusEvent>;
onSynInput: EventName<SynInputEvent>;
}>;
export type { SynBlurEvent } from '@synergy-design-system/components';
export type { SynChangeEvent } from '@synergy-design-system/components';
export type { SynErrorEvent } from '@synergy-design-system/components';
export type { SynFocusEvent } from '@synergy-design-system/components';
export type { SynInputEvent } from '@synergy-design-system/components';