@synergy-design-system/react
Version:
React wrappers for the Synergy Design System
47 lines (46 loc) • 2.63 kB
TypeScript
import Component from '@synergy-design-system/components/components/details/details.component.js';
import { type EventName } from '@lit/react';
import type { SynShowEvent } from '@synergy-design-system/components';
import type { SynAfterShowEvent } from '@synergy-design-system/components';
import type { SynHideEvent } from '@synergy-design-system/components';
import type { SynAfterHideEvent } from '@synergy-design-system/components';
/**
* @summary Details show a brief summary and expand to show additional content.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-details--docs
* @status stable
* @since 2.0
*
* @dependency syn-icon
*
* @slot - The details' main content.
* @slot summary - The details' summary. Alternatively, you can use the `summary` attribute.
* @slot expand-icon - Optional expand icon to use instead of the default. Works best with `<syn-icon>`.
* @slot collapse-icon - Optional collapse icon to use instead of the default. Works best with `<syn-icon>`.
*
* @event syn-show - Emitted when the details opens.
* @event syn-after-show - Emitted after the details opens and all animations are complete.
* @event syn-hide - Emitted when the details closes.
* @event syn-after-hide - Emitted after the details closes and all animations are complete.
*
* @csspart base - The component's base wrapper.
* @csspart header - The header that wraps both the summary and the expand/collapse icon.
* @csspart summary - The container that wraps the summary.
* @csspart summary-icon - The container that wraps the expand/collapse icons.
* @csspart content - The details content.
* @csspart body - The container that wraps the details content.
*
* @animation details.show - The animation to use when showing details. You can use `height: auto` with this animation.
* @animation details.hide - The animation to use when hiding details. You can use `height: auto` with this animation.
*
* @cssproperty --syn-details-open-rotation - The rotation angle of the summary icon when the details is open.
*/
export declare const SynDetails: import("@lit/react").ReactWebComponent<Component, {
onSynShow: EventName<SynShowEvent>;
onSynAfterShow: EventName<SynAfterShowEvent>;
onSynHide: EventName<SynHideEvent>;
onSynAfterHide: EventName<SynAfterHideEvent>;
}>;
export type { SynShowEvent } from '@synergy-design-system/components';
export type { SynAfterShowEvent } from '@synergy-design-system/components';
export type { SynHideEvent } from '@synergy-design-system/components';
export type { SynAfterHideEvent } from '@synergy-design-system/components';