- Name
service- Kind
- parameter
- Type
DiffViewerService- Requirement
- required
DocsAPI referenceHeadlessdiff-viewer
diff-viewer headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
@grassroot/ui-headless-core/diff-viewer
Core connector and vanilla API
connectDiffViewer
functiondeclare function connectDiffViewer(service: DiffViewerService, scope: PartScope, options?: DiffViewerConnectOptions): DiffViewerApi;serviceDiffViewerServicescopePartScopeoptionsDiffViewerConnectOptionsreturnDiffViewerApi- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
DiffViewerConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
DiffViewerApi- Requirement
- n/a
diffViewerAnatomy
valueexport declare const diffViewerAnatomy: { readonly scope: "diff-viewer"; readonly parts: readonly ["root", "mode-button"];};partsreadonly ["root", "mode-button"]scope"diff-viewer"- Name
parts- Kind
- property
- Type
readonly ["root", "mode-button"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"diff-viewer"- Requirement
- required
DiffViewerApi
interfaceinterface DiffViewerApi { rootProps(): PartProps; modeButtonProps(mode: DiffViewerMode): PartProps; readonly mode: DiffViewerMode; readonly disabled: boolean;}disabledbooleanmodeDiffViewerModemodeButtonProps(mode: DiffViewerMode) => PartPropsrootProps() => PartProps- Name
disabled- Kind
- property
- Type
boolean- Requirement
- required
- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- required
- Name
modeButtonProps- Kind
- method
- Type
(mode: DiffViewerMode) => PartProps- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
DiffViewerChangeDetail
interfaceinterface DiffViewerChangeDetail { readonly mode: DiffViewerMode; readonly reason: "pointer" | "keyboard" | "programmatic";}modeDiffViewerModereason"pointer" | "keyboard" | "programmatic"- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- required
- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
DiffViewerConnectOptions
interfaceinterface DiffViewerConnectOptions { readonly ariaLabel?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;}ariaLabelstringonModeChange(detail: DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
DiffViewerMount
interfaceinterface DiffViewerMount { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly root: HTMLDivElement; destroy(): void;}connectorDiffViewerApidestroy() => voidrootHTMLDivElementserviceDiffViewerService- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLDivElement- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
DiffViewerPart
typetype DiffViewerPart = (typeof diffViewerAnatomy.parts)[number];DiffViewerService
typetype DiffViewerService = Service<DiffViewerInput, "ready", DiffViewerContext, DiffViewerEvent, DiffViewerCommand>;mountDiffViewer
functiondeclare function mountDiffViewer(container: HTMLElement, options?: MountDiffViewerOptions): DiffViewerMount;containerHTMLElementoptionsMountDiffViewerOptionsreturnDiffViewerMount- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountDiffViewerOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
DiffViewerMount- Requirement
- n/a
MountDiffViewerOptions
interfaceinterface MountDiffViewerOptions { readonly mode?: DiffViewerMode; readonly defaultMode?: DiffViewerMode; readonly disabled?: boolean; readonly ariaLabel?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;}ariaLabelstringdefaultModeDiffViewerModedisabledbooleanmodeDiffViewerModeonModeChange(detail: DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
defaultMode- Kind
- property
- Type
DiffViewerMode- Requirement
- optional
- Name
disabled- Kind
- property
- Type
boolean- Requirement
- optional
- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
runDiffViewerCommand
functiondeclare function runDiffViewerCommand(command: DiffViewerCommand, options?: DiffViewerConnectOptions): void;commandDiffViewerCommandoptionsDiffViewerConnectOptionsreturnvoid- Name
command- Kind
- parameter
- Type
DiffViewerCommand- Requirement
- required
- Name
options- Kind
- parameter
- Type
DiffViewerConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React imports
import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-react/diff-viewer";Vue imports
<script setup lang="ts">import { DiffViewerModeButton, DiffViewerRoot, DiffViewerRootProvider } from "@grassroot/ui-headless-vue/diff-viewer";</script>Angular imports
import { GrDiffViewerModeButton, GrDiffViewerRoot, GrDiffViewerRootProvider } from "@grassroot/ui-headless-angular/diff-viewer";Svelte imports
<script lang="ts"> import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-svelte/diff-viewer";</script>Solid imports
import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-solid/diff-viewer";@grassroot/ui-headless-react/diff-viewer
React adapter
DiffViewerRootProps
interfaceinterface DiffViewerRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> { readonly mode?: DiffViewerMode; readonly defaultMode?: DiffViewerMode; readonly disabled?: boolean; readonly ariaLabel?: string; readonly id?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void; readonly children?: ReactNode;}ariaLabelstringchildrenReactNodedefaultModeDiffViewerModedisabledbooleanidstringmodeDiffViewerModeonModeChange(detail: DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
defaultMode- Kind
- property
- Type
DiffViewerMode- Requirement
- optional
- Name
disabled- Kind
- property
- Type
boolean- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
DiffViewerRootProviderProps
interfaceinterface DiffViewerRootProviderProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> { readonly value: UseDiffViewerResult; readonly children?: ReactNode;}childrenReactNodevalueUseDiffViewerResult- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
value- Kind
- property
- Type
UseDiffViewerResult- Requirement
- required
ModeButton
valueexport declare const ModeButton: import("react").ForwardRefExoticComponent<ModeButtonProps & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
ModeButtonProps
interfaceinterface ModeButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> { readonly mode: DiffViewerMode; readonly children?: ReactNode;}childrenReactNodemodeDiffViewerMode- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- required
Root
valueexport declare const Root: import("react").ForwardRefExoticComponent<DiffViewerRootProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: import("react").ForwardRefExoticComponent<DiffViewerRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
useDiffViewer
functiondeclare function useDiffViewer(input: DiffViewerInput, options?: UseDiffViewerOptions): UseDiffViewerResult;inputDiffViewerInputoptionsUseDiffViewerOptionsreturnUseDiffViewerResult- Name
input- Kind
- parameter
- Type
DiffViewerInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseDiffViewerOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseDiffViewerResult- Requirement
- n/a
UseDiffViewerOptions
interfaceinterface UseDiffViewerOptions extends DiffViewerConnectOptions { readonly id?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;}idstringonModeChange(detail: DiffViewerChangeDetail) => void- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
UseDiffViewerResult
interfaceinterface UseDiffViewerResult { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly scope: PartScope; readonly snapshot: DiffViewerSnapshot;}connectorDiffViewerApiscopePartScopeserviceDiffViewerServicesnapshotDiffViewerSnapshot- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
DiffViewerSnapshot- Requirement
- required
@grassroot/ui-headless-vue/diff-viewer
Vue adapter
DiffViewerModeButton
valueexport declare const DiffViewerModeButton: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: { type: PropType<DiffViewerMode>; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: { type: PropType<DiffViewerMode>; required: true; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;DiffViewerRoot
valueexport declare const DiffViewerRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: PropType<DiffViewerMode>; defaultMode: PropType<DiffViewerMode>; disabled: BooleanConstructor; ariaLabel: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { modeChange: (_detail: DiffViewerChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: PropType<DiffViewerMode>; defaultMode: PropType<DiffViewerMode>; disabled: BooleanConstructor; ariaLabel: StringConstructor;}>> & Readonly<{ onModeChange?: ((_detail: DiffViewerChangeDetail) => any) | undefined;}>, { asChild: boolean; disabled: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;DiffViewerRootProvider
valueexport declare const DiffViewerRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: PropType<DiffViewerMode>; defaultMode: PropType<DiffViewerMode>; disabled: BooleanConstructor; ariaLabel: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { modeChange: (_detail: DiffViewerChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; mode: PropType<DiffViewerMode>; defaultMode: PropType<DiffViewerMode>; disabled: BooleanConstructor; ariaLabel: StringConstructor;}>> & Readonly<{ onModeChange?: ((_detail: DiffViewerChangeDetail) => any) | undefined;}>, { asChild: boolean; disabled: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;useDiffViewer
functiondeclare function useDiffViewer(input: () => DiffViewerInput, options?: () => DiffViewerOptions): UseDiffViewerResult;input() => DiffViewerInputoptions() => DiffViewerOptionsreturnUseDiffViewerResult- Name
input- Kind
- parameter
- Type
() => DiffViewerInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
() => DiffViewerOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseDiffViewerResult- Requirement
- n/a
UseDiffViewerResult
interfaceinterface UseDiffViewerResult { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly scope: PartScope; readonly snapshot: ShallowRef<DiffViewerSnapshot>;}connectorDiffViewerApiscopePartScopeserviceDiffViewerServicesnapshotShallowRef<DiffViewerSnapshot>- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<DiffViewerSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/diff-viewer
Angular adapter
createDiffViewerStore
functionexport declare function createDiffViewerStore(initial: DiffViewerInput, options?: CreateDiffViewerStoreOptions): DiffViewerStore;initialDiffViewerInputoptionsCreateDiffViewerStoreOptionsreturnDiffViewerStore- Name
initial- Kind
- parameter
- Type
DiffViewerInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
CreateDiffViewerStoreOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
DiffViewerStore- Requirement
- n/a
CreateDiffViewerStoreOptions
interfaceexport interface CreateDiffViewerStoreOptions { readonly ariaLabel?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void; readonly onCommit?: () => void;}ariaLabelstringonCommit() => voidonModeChange(detail: DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
onCommit- Kind
- property
- Type
() => void- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
DiffViewerStore
interfaceexport interface DiffViewerStore { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: DiffViewerInput): void;}connectorDiffViewerApiscopePartScopeserviceDiffViewerServicestart() => voidstop() => voidsync(input: DiffViewerInput) => voidversionWritableSignal<number>- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: DiffViewerInput) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
GrDiffViewerModeButton
classexport declare class GrDiffViewerModeButton implements OnDestroy { readonly mode: import("@angular/core").InputSignal<DiffViewerMode>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; private registered; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrDiffViewerModeButton, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrDiffViewerModeButton, "[grDiffViewerModeButton]", never, { "mode": { "alias": "mode"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanylistenersanymodeimport("@angular/core").InputSignal<DiffViewerMode>ngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrDiffViewerModeButton, "[grDiffViewerModeButton]", never, { "mode": { "alias": "mode"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrDiffViewerModeButton, never>registeredanystoreany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
mode- Kind
- property
- Type
import("@angular/core").InputSignal<DiffViewerMode>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrDiffViewerModeButton, "[grDiffViewerModeButton]", never, { "mode": { "alias": "mode"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrDiffViewerModeButton, never>- Requirement
- required
- Name
registered- Kind
- property
- Type
any- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrDiffViewerRoot
classexport declare class GrDiffViewerRoot implements OnDestroy { readonly mode: import("@angular/core").InputSignal<DiffViewerMode | undefined>; readonly defaultMode: import("@angular/core").InputSignal<DiffViewerMode | undefined>; readonly disabled: import("@angular/core").InputSignal<boolean | undefined>; readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>; readonly modeChange: import("@angular/core").OutputEmitterRef<DiffViewerChangeDetail>; readonly store: DiffViewerStore; private readonly host; private readonly listeners; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrDiffViewerRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrDiffViewerRoot, "gr-diff-viewer-root", never, { "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "defaultMode": { "alias": "defaultMode"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "modeChange": "modeChange"; }, never, ["*"], true, never>;}ariaLabelimport("@angular/core").InputSignal<string | undefined>defaultModeimport("@angular/core").InputSignal<DiffViewerMode | undefined>disabledimport("@angular/core").InputSignal<boolean | undefined>hostanylastanylistenersanymodeimport("@angular/core").InputSignal<DiffViewerMode | undefined>modeChangeimport("@angular/core").OutputEmitterRef<DiffViewerChangeDetail>ngOnDestroy() => voidɵcmpi0.ɵɵComponentDeclaration<GrDiffViewerRoot, "gr-diff-viewer-root", never, { "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "defaultMode": { "alias": "defaultMode"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "modeChange": "modeChange"; }, never, ["*"], true, never>ɵfaci0.ɵɵFactoryDeclaration<GrDiffViewerRoot, never>storeDiffViewerStore- Name
ariaLabel- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
defaultMode- Kind
- property
- Type
import("@angular/core").InputSignal<DiffViewerMode | undefined>- Requirement
- required
- Name
disabled- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
mode- Kind
- property
- Type
import("@angular/core").InputSignal<DiffViewerMode | undefined>- Requirement
- required
- Name
modeChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<DiffViewerChangeDetail>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrDiffViewerRoot, "gr-diff-viewer-root", never, { "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "defaultMode": { "alias": "defaultMode"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "modeChange": "modeChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrDiffViewerRoot, never>- Requirement
- required
- Name
store- Kind
- property
- Type
DiffViewerStore- Requirement
- required
GrDiffViewerRootProvider
classexport declare class GrDiffViewerRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrDiffViewerRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrDiffViewerRootProvider, "gr-diff-viewer-root-provider", never, {}, {}, never, ["*"], true, never>;}hostanylistenersanyngOnDestroy() => voidɵcmpi0.ɵɵComponentDeclaration<GrDiffViewerRootProvider, "gr-diff-viewer-root-provider", never, {}, {}, never, ["*"], true, never>ɵfaci0.ɵɵFactoryDeclaration<GrDiffViewerRootProvider, never>storeany- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrDiffViewerRootProvider, "gr-diff-viewer-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrDiffViewerRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
@grassroot/ui-headless-svelte/diff-viewer
Svelte adapter
createDiffViewer
functionexport declare function createDiffViewer(input: () => DiffViewerInput, options?: UseDiffViewerOptions): UseDiffViewerResult;input() => DiffViewerInputoptionsUseDiffViewerOptionsreturnUseDiffViewerResult- Name
input- Kind
- parameter
- Type
() => DiffViewerInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseDiffViewerOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseDiffViewerResult- Requirement
- n/a
ModeButton
valueexport declare const ModeButton: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Root
valueexport declare const Root: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
UseDiffViewerOptions
interfaceexport interface UseDiffViewerOptions { readonly id?: string; readonly ariaLabel?: string; readonly onModeChange?: (detail: import("@grassroot/ui-headless-core/diff-viewer").DiffViewerChangeDetail) => void;}ariaLabelstringidstringonModeChange(detail: import("@grassroot/ui-headless-core/diff-viewer").DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: import("@grassroot/ui-headless-core/diff-viewer").DiffViewerChangeDetail) => void- Requirement
- optional
UseDiffViewerResult
interfaceexport interface UseDiffViewerResult { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>; readonly version: () => number;}connectorDiffViewerApiscopeReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>serviceDiffViewerServiceversion() => number- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
scope- Kind
- property
- Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/diff-viewer
Solid adapter
DiffViewerRootProps
interfaceexport interface DiffViewerRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange">, DiffViewerInput { readonly ariaLabel?: string; readonly id?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void; readonly children?: JSX.Element;}ariaLabelstringchildrenJSX.ElementidstringonModeChange(detail: DiffViewerChangeDetail) => void- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
children- Kind
- property
- Type
JSX.Element- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
DiffViewerRootProviderProps
interfaceexport interface DiffViewerRootProviderProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> { readonly value: UseDiffViewerResult; readonly children?: JSX.Element;}childrenJSX.ElementvalueUseDiffViewerResult- Name
children- Kind
- property
- Type
JSX.Element- Requirement
- optional
- Name
value- Kind
- property
- Type
UseDiffViewerResult- Requirement
- required
ModeButton
functionexport declare function ModeButton(props: ModeButtonProps): JSX.Element;propsModeButtonPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
ModeButtonProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
ModeButtonProps
interfaceexport interface ModeButtonProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement> { readonly mode: DiffViewerMode; readonly children?: JSX.Element;}childrenJSX.ElementmodeDiffViewerMode- Name
children- Kind
- property
- Type
JSX.Element- Requirement
- optional
- Name
mode- Kind
- property
- Type
DiffViewerMode- Requirement
- required
Root
functionexport declare function Root(props: DiffViewerRootProps): JSX.Element;propsDiffViewerRootPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
DiffViewerRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
RootProvider
functionexport declare function RootProvider(props: DiffViewerRootProviderProps): JSX.Element;propsDiffViewerRootProviderPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
DiffViewerRootProviderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
useDiffViewer
functionexport declare function useDiffViewer(input: Accessor<DiffViewerInput>, options?: UseDiffViewerOptions): UseDiffViewerResult;inputAccessor<DiffViewerInput>optionsUseDiffViewerOptionsreturnUseDiffViewerResult- Name
input- Kind
- parameter
- Type
Accessor<DiffViewerInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseDiffViewerOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseDiffViewerResult- Requirement
- n/a
UseDiffViewerOptions
interfaceexport interface UseDiffViewerOptions extends DiffViewerConnectOptions { readonly id?: string; readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;}idstringonModeChange(detail: DiffViewerChangeDetail) => void- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onModeChange- Kind
- property
- Type
(detail: DiffViewerChangeDetail) => void- Requirement
- optional
UseDiffViewerResult
interfaceexport interface UseDiffViewerResult { readonly service: DiffViewerService; readonly connector: DiffViewerApi; readonly scope: PartScope; readonly snapshot: Accessor<DiffViewerSnapshot>;}connectorDiffViewerApiscopePartScopeserviceDiffViewerServicesnapshotAccessor<DiffViewerSnapshot>- Name
connector- Kind
- property
- Type
DiffViewerApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
DiffViewerService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<DiffViewerSnapshot>- Requirement
- required