Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ManualRefreshButton

Renders the standard refresh icon button with an in-progress state.

Import

import { ManualRefreshButton } from "@dartwic/interface-sdk/ui";

Declaration

export const ManualRefreshButton: HostComponent<ManualRefreshButtonProps>;

ManualRefreshButtonProps

Props for the standard refresh icon button.

export interface ManualRefreshButtonProps extends ButtonProps {
    /** Tooltip and accessible label. */
    tooltip?: string;
    /** Shows the spinning refresh state and disables the button. */
    isRefreshing?: boolean;
}
PropTypeRequirementDescription
tooltipstringOptionalTooltip and accessible label.
isRefreshingbooleanOptionalShows the spinning refresh state and disables the button.
variant"default" | "destructive" | "outline" | "secondary" | "ghost" | "link"OptionalVisual style preset.
size"default" | "sm" | "lg" | "icon"OptionalSize preset.
asChildbooleanOptionalRender through the host’s slot component.
onClickHostEventHandlerOptionalClick event handler.
disabledbooleanOptionalDisables interaction.
type"button" | "submit" | "reset" | stringOptionalNative button type.
classNamestringOptionalAdditional Tailwind or host CSS classes.
childrenHostNodeOptionalChild content rendered by the host component.
idstringOptionalOptional DOM identifier.
styleRecord<string, unknown>OptionalInline style values passed to the host component.