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

11 exports
View source packages/ui-headless/core/src/diff-viewer/index.ts
DeclarationView source
connectDiffViewerts
declare function connectDiffViewer(service: DiffViewerService, scope: PartScope, options?: DiffViewerConnectOptions): DiffViewerApi;
Name
Kind
Type
Requirement
service
parameter
DiffViewerService
required
scope
parameter
PartScope
required
options
parameter
DiffViewerConnectOptions
optional
return
return value
DiffViewerApi
n/a
Name
service
Kind
parameter
Type
DiffViewerService
Requirement
required
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
DeclarationView source
diffViewerAnatomyts
export declare const diffViewerAnatomy: {
readonly scope: "diff-viewer";
readonly parts: readonly ["root", "mode-button"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "mode-button"]
required
scope
property
"diff-viewer"
required
Name
parts
Kind
property
Type
readonly ["root", "mode-button"]
Requirement
required
Name
scope
Kind
property
Type
"diff-viewer"
Requirement
required

DiffViewerApi

interface
DeclarationView source
DiffViewerApits
interface DiffViewerApi {
rootProps(): PartProps;
modeButtonProps(mode: DiffViewerMode): PartProps;
readonly mode: DiffViewerMode;
readonly disabled: boolean;
}
Name
Kind
Type
Requirement
disabled
property
boolean
required
mode
property
DiffViewerMode
required
modeButtonProps
method
(mode: DiffViewerMode) => PartProps
required
rootProps
method
() => PartProps
required
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
DeclarationView source
DiffViewerChangeDetailts
interface DiffViewerChangeDetail {
readonly mode: DiffViewerMode;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
mode
property
DiffViewerMode
required
reason
property
"pointer" | "keyboard" | "programmatic"
required
Name
mode
Kind
property
Type
DiffViewerMode
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
DeclarationView source
DiffViewerConnectOptionsts
interface DiffViewerConnectOptions {
readonly ariaLabel?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
onModeChange
Kind
property
Type
(detail: DiffViewerChangeDetail) => void
Requirement
optional

DiffViewerMount

interface
DeclarationView source
DiffViewerMountts
interface DiffViewerMount {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly root: HTMLDivElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
destroy
method
() => void
required
root
property
HTMLDivElement
required
service
property
DiffViewerService
required
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
DeclarationView source
DiffViewerPartts
type DiffViewerPart = (typeof diffViewerAnatomy.parts)[number];
DeclarationView source
DiffViewerServicets
type DiffViewerService = Service<DiffViewerInput, "ready", DiffViewerContext, DiffViewerEvent, DiffViewerCommand>;

mountDiffViewer

function
DeclarationView source
mountDiffViewerts
declare function mountDiffViewer(container: HTMLElement, options?: MountDiffViewerOptions): DiffViewerMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountDiffViewerOptions
optional
return
return value
DiffViewerMount
n/a
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
DeclarationView source
MountDiffViewerOptionsts
interface MountDiffViewerOptions {
readonly mode?: DiffViewerMode;
readonly defaultMode?: DiffViewerMode;
readonly disabled?: boolean;
readonly ariaLabel?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
defaultMode
property
DiffViewerMode
optional
disabled
property
boolean
optional
mode
property
DiffViewerMode
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
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
DeclarationView source
runDiffViewerCommandts
declare function runDiffViewerCommand(command: DiffViewerCommand, options?: DiffViewerConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
DiffViewerCommand
required
options
parameter
DiffViewerConnectOptions
optional
return
return value
void
n/a
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 example follows below.

React imports

@grassroot/ui-headless-react/diff-viewerts
import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-react/diff-viewer";

Vue imports

@grassroot/ui-headless-vue/diff-viewerts
<script setup lang="ts">
import { DiffViewerModeButton, DiffViewerRoot, DiffViewerRootProvider } from "@grassroot/ui-headless-vue/diff-viewer";
</script>

Angular imports

@grassroot/ui-headless-angular/diff-viewerts
import { GrDiffViewerModeButton, GrDiffViewerRoot, GrDiffViewerRootProvider } from "@grassroot/ui-headless-angular/diff-viewer";

Svelte imports

@grassroot/ui-headless-svelte/diff-viewerts
<script lang="ts">
import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-svelte/diff-viewer";
</script>

Solid imports

@grassroot/ui-headless-solid/diff-viewerts
import { ModeButton, Root, RootProvider } from "@grassroot/ui-headless-solid/diff-viewer";

@grassroot/ui-headless-react/diff-viewer

React adapter

9 exports
View source packages/ui-headless/react/src/diff-viewer/index.ts
DeclarationView source
DiffViewerRootPropsts
interface 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;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
ReactNode
optional
defaultMode
property
DiffViewerMode
optional
disabled
property
boolean
optional
id
property
string
optional
mode
property
DiffViewerMode
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
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
DeclarationView source
DiffViewerRootProviderPropsts
interface DiffViewerRootProviderProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> {
readonly value: UseDiffViewerResult;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
value
property
UseDiffViewerResult
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseDiffViewerResult
Requirement
required

ModeButton

value
DeclarationView source
ModeButtonts
export declare const ModeButton: import("react").ForwardRefExoticComponent<ModeButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

ModeButtonProps

interface
DeclarationView source
ModeButtonPropsts
interface ModeButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
readonly mode: DiffViewerMode;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
mode
property
DiffViewerMode
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
mode
Kind
property
Type
DiffViewerMode
Requirement
required

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<DiffViewerRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<DiffViewerRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useDiffViewer

function
DeclarationView source
useDiffViewerts
declare function useDiffViewer(input: DiffViewerInput, options?: UseDiffViewerOptions): UseDiffViewerResult;
Name
Kind
Type
Requirement
input
parameter
DiffViewerInput
required
options
parameter
UseDiffViewerOptions
optional
return
return value
UseDiffViewerResult
n/a
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
DeclarationView source
UseDiffViewerOptionsts
interface UseDiffViewerOptions extends DiffViewerConnectOptions {
readonly id?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
}
Name
Kind
Type
Requirement
id
property
string
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onModeChange
Kind
property
Type
(detail: DiffViewerChangeDetail) => void
Requirement
optional
DeclarationView source
UseDiffViewerResultts
interface UseDiffViewerResult {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly scope: PartScope;
readonly snapshot: DiffViewerSnapshot;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
scope
property
PartScope
required
service
property
DiffViewerService
required
snapshot
property
DiffViewerSnapshot
required
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

5 exports
View source packages/ui-headless/vue/src/diff-viewer/index.ts
DeclarationView source
DiffViewerModeButtonts
export 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>;
DeclarationView source
DiffViewerRootts
export 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>;
DeclarationView source
DiffViewerRootProviderts
export 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

function
DeclarationView source
useDiffViewerts
declare function useDiffViewer(input: () => DiffViewerInput, options?: () => DiffViewerOptions): UseDiffViewerResult;
Name
Kind
Type
Requirement
input
parameter
() => DiffViewerInput
required
options
parameter
() => DiffViewerOptions
optional
return
return value
UseDiffViewerResult
n/a
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
DeclarationView source
UseDiffViewerResultts
interface UseDiffViewerResult {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<DiffViewerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
scope
property
PartScope
required
service
property
DiffViewerService
required
snapshot
property
ShallowRef<DiffViewerSnapshot>
required
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

6 exports
View source packages/ui-headless/angular/src/diff-viewer/index.ts
DeclarationView source
createDiffViewerStorets
export declare function createDiffViewerStore(initial: DiffViewerInput, options?: CreateDiffViewerStoreOptions): DiffViewerStore;
Name
Kind
Type
Requirement
initial
parameter
DiffViewerInput
required
options
parameter
CreateDiffViewerStoreOptions
optional
return
return value
DiffViewerStore
n/a
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
DeclarationView source
CreateDiffViewerStoreOptionsts
export interface CreateDiffViewerStoreOptions {
readonly ariaLabel?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
onCommit
property
() => void
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
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

interface
DeclarationView source
DiffViewerStorets
export interface DiffViewerStore {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: DiffViewerInput): void;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
scope
property
PartScope
required
service
property
DiffViewerService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: DiffViewerInput) => void
required
version
property
WritableSignal<number>
required
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
DeclarationView source
GrDiffViewerModeButtonts
export 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>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
mode
property
import("@angular/core").InputSignal<DiffViewerMode>
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrDiffViewerModeButton, "[grDiffViewerModeButton]", never, { "mode": { "alias": "mode"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDiffViewerModeButton, never>
required
registered
property
any
required
store
property
any
required
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
DeclarationView source
GrDiffViewerRootts
export 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>;
}
Name
Kind
Type
Requirement
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
defaultMode
property
import("@angular/core").InputSignal<DiffViewerMode | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean | undefined>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
mode
property
import("@angular/core").InputSignal<DiffViewerMode | undefined>
required
modeChange
property
import("@angular/core").OutputEmitterRef<DiffViewerChangeDetail>
required
ngOnDestroy
method
() => void
required
ɵcmp
property
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>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDiffViewerRoot, never>
required
store
property
DiffViewerStore
required
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
DeclarationView source
GrDiffViewerRootProviderts
export 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>;
}
Name
Kind
Type
Requirement
host
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDiffViewerRootProvider, "gr-diff-viewer-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDiffViewerRootProvider, never>
required
store
property
any
required
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

6 exports
View source packages/ui-headless/svelte/src/diff-viewer/index.ts

createDiffViewer

function
DeclarationView source
createDiffViewerts
export declare function createDiffViewer(input: () => DiffViewerInput, options?: UseDiffViewerOptions): UseDiffViewerResult;
Name
Kind
Type
Requirement
input
parameter
() => DiffViewerInput
required
options
parameter
UseDiffViewerOptions
optional
return
return value
UseDiffViewerResult
n/a
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

value
DeclarationView source
ModeButtonts
export declare const ModeButton: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
Rootts
export declare const Root: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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

value
DeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
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
DeclarationView source
UseDiffViewerOptionsts
export interface UseDiffViewerOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onModeChange?: (detail: import("@grassroot/ui-headless-core/diff-viewer").DiffViewerChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onModeChange
property
(detail: import("@grassroot/ui-headless-core/diff-viewer").DiffViewerChangeDetail) => void
optional
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
DeclarationView source
UseDiffViewerResultts
export interface UseDiffViewerResult {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
DiffViewerService
required
version
property
() => number
required
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

9 exports
View source packages/ui-headless/solid/src/diff-viewer/index.ts
DeclarationView source
DiffViewerRootPropsts
export interface DiffViewerRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange">, DiffViewerInput {
readonly ariaLabel?: string;
readonly id?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
JSX.Element
optional
id
property
string
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
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
DeclarationView source
DiffViewerRootProviderPropsts
export interface DiffViewerRootProviderProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> {
readonly value: UseDiffViewerResult;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
value
property
UseDiffViewerResult
required
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
value
Kind
property
Type
UseDiffViewerResult
Requirement
required

ModeButton

function
DeclarationView source
ModeButtonts
export declare function ModeButton(props: ModeButtonProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
ModeButtonProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
ModeButtonProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

ModeButtonProps

interface
DeclarationView source
ModeButtonPropsts
export interface ModeButtonProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement> {
readonly mode: DiffViewerMode;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
mode
property
DiffViewerMode
required
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
mode
Kind
property
Type
DiffViewerMode
Requirement
required

Root

function
DeclarationView source
Rootts
export declare function Root(props: DiffViewerRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DiffViewerRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DiffViewerRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: DiffViewerRootProviderProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
DiffViewerRootProviderProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
DiffViewerRootProviderProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useDiffViewer

function
DeclarationView source
useDiffViewerts
export declare function useDiffViewer(input: Accessor<DiffViewerInput>, options?: UseDiffViewerOptions): UseDiffViewerResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<DiffViewerInput>
required
options
parameter
UseDiffViewerOptions
optional
return
return value
UseDiffViewerResult
n/a
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
DeclarationView source
UseDiffViewerOptionsts
export interface UseDiffViewerOptions extends DiffViewerConnectOptions {
readonly id?: string;
readonly onModeChange?: (detail: DiffViewerChangeDetail) => void;
}
Name
Kind
Type
Requirement
id
property
string
optional
onModeChange
property
(detail: DiffViewerChangeDetail) => void
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onModeChange
Kind
property
Type
(detail: DiffViewerChangeDetail) => void
Requirement
optional
DeclarationView source
UseDiffViewerResultts
export interface UseDiffViewerResult {
readonly service: DiffViewerService;
readonly connector: DiffViewerApi;
readonly scope: PartScope;
readonly snapshot: Accessor<DiffViewerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DiffViewerApi
required
scope
property
PartScope
required
service
property
DiffViewerService
required
snapshot
property
Accessor<DiffViewerSnapshot>
required
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