DocsAPI referenceHeadlessgantt

gantt 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/gantt

Core connector and vanilla API

41 exports
View source packages/ui-headless/core/src/gantt/index.ts

axisFromPointer

function
DeclarationView source
axisFromPointerts
declare function axisFromPointer(clientX: number, track: GanttRectLike, columnCount: number): number;
Name
Kind
Type
Requirement
clientX
parameter
number
required
track
parameter
GanttRectLike
required
columnCount
parameter
number
required
return
return value
number
n/a
Name
clientX
Kind
parameter
Type
number
Requirement
required
Name
track
Kind
parameter
Type
GanttRectLike
Requirement
required
Name
columnCount
Kind
parameter
Type
number
Requirement
required
Name
return
Kind
return value
Type
number
Requirement
n/a

blockedGanttIds

function

Empty and duplicate ids are blocked. All ids are blocked when step is invalid.

DeclarationView source
blockedGanttIdsts
declare function blockedGanttIds(input: GanttInput): ReadonlySet<string>;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
return
return value
ReadonlySet<string>
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
return
Kind
return value
Type
ReadonlySet<string>
Requirement
n/a

clampGanttRange

function

Translate a range by preserving width and clamping to `[0, columnCount]`. Returns `null` when the bar is wider than the domain (cannot move).

DeclarationView source
clampGanttRangets
declare function clampGanttRange(start: number, end: number, columnCount: number): {
readonly start: number;
readonly end: number;
} | null;
Name
Kind
Type
Requirement
start
parameter
number
required
end
parameter
number
required
columnCount
parameter
number
required
return
return value
{ readonly start: number; readonly end: number; } | null
n/a
Name
start
Kind
parameter
Type
number
Requirement
required
Name
end
Kind
parameter
Type
number
Requirement
required
Name
columnCount
Kind
parameter
Type
number
Requirement
required
Name
return
Kind
return value
Type
{ readonly start: number; readonly end: number; } | null
Requirement
n/a

columnCountOf

function
DeclarationView source
columnCountOfts
declare function columnCountOf(input: GanttInput): number;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
return
return value
number
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
return
Kind
return value
Type
number
Requirement
n/a

connectGantt

function
DeclarationView source
connectGanttts
declare function connectGantt(service: GanttService, scope: PartScope, options?: GanttConnectOptions): GanttApi;
Name
Kind
Type
Requirement
service
parameter
GanttService
required
scope
parameter
PartScope
required
options
parameter
GanttConnectOptions
optional
return
return value
GanttApi
n/a
Name
service
Kind
parameter
Type
GanttService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
GanttConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
GanttApi
Requirement
n/a
DeclarationView source
createGanttControllerts
declare function createGanttController(host: GanttControllerHost): GanttController;
Name
Kind
Type
Requirement
host
parameter
GanttControllerHost
required
return
return value
GanttController
n/a
Name
host
Kind
parameter
Type
GanttControllerHost
Requirement
required
Name
return
Kind
return value
Type
GanttController
Requirement
n/a
DeclarationView source
GANTT_DEFAULT_COLUMN_COUNTts
export declare const GANTT_DEFAULT_COLUMN_COUNT: 4;
DeclarationView source
GANTT_DEFAULT_STEPts
export declare const GANTT_DEFAULT_STEP: 1;

ganttAnatomy

value
DeclarationView source
ganttAnatomyts
export declare const ganttAnatomy: {
readonly scope: "gantt";
readonly parts: readonly ["root", "list", "row", "track", "bar"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "list", "row", "track", "bar"]
required
scope
property
"gantt"
required
Name
parts
Kind
property
Type
readonly ["root", "list", "row", "track", "bar"]
Requirement
required
Name
scope
Kind
property
Type
"gantt"
Requirement
required

GanttApi

interface
DeclarationView source
GanttApits
interface GanttApi {
rootProps(): PartProps;
listProps(): PartProps;
rowProps(id: string): PartProps;
trackProps(id: string): PartProps;
barProps(id: string): PartProps;
rangeFor(id: string): GanttBarRange | undefined;
readonly value: GanttStateValue;
readonly interactive: boolean;
}
Name
Kind
Type
Requirement
barProps
method
(id: string) => PartProps
required
interactive
property
boolean
required
listProps
method
() => PartProps
required
rangeFor
method
(id: string) => GanttBarRange | undefined
required
rootProps
method
() => PartProps
required
rowProps
method
(id: string) => PartProps
required
trackProps
method
(id: string) => PartProps
required
value
property
GanttStateValue
required
Name
barProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
interactive
Kind
property
Type
boolean
Requirement
required
Name
listProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rangeFor
Kind
method
Type
(id: string) => GanttBarRange | undefined
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rowProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
trackProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
value
Kind
property
Type
GanttStateValue
Requirement
required
DeclarationView source
GanttBarRangets
type GanttBarRange = {
readonly id: string;
readonly start: number;
readonly end: number;
};
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required
DeclarationView source
GanttChangeReasonts
type GanttChangeReason = "pointer" | "keyboard";
DeclarationView source
GanttCommandts
type GanttCommand = CommandObject & {
readonly type: "BAR_RANGE_CHANGE_REQUEST";
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: GanttChangeReason;
};
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
GanttChangeReason
required
start
property
number
required
type
property
string
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
GanttChangeReason
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
GanttConnectOptionsts
interface GanttConnectOptions {
onRangeChange?: (detail: GanttRangeChangeDetail) => void;
beginPointer?: (detail: {
readonly id: string;
readonly start: number;
readonly end: number;
readonly clientX: number;
}) => void;
}
Name
Kind
Type
Requirement
beginPointer
property
(detail: { readonly id: string; readonly start: number; readonly end: number; readonly clientX: number; }) => void
optional
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
beginPointer
Kind
property
Type
(detail: { readonly id: string; readonly start: number; readonly end: number; readonly clientX: number; }) => void
Requirement
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional
DeclarationView source
GanttContextts
type GanttContext = {
readonly focusedId: string | null;
readonly activeId: string | null;
readonly originStart: number | null;
readonly originEnd: number | null;
readonly draftStart: number | null;
readonly draftEnd: number | null;
readonly reason: GanttChangeReason | null;
};
Name
Kind
Type
Requirement
activeId
property
string | null
required
draftEnd
property
number | null
required
draftStart
property
number | null
required
focusedId
property
string | null
required
originEnd
property
number | null
required
originStart
property
number | null
required
reason
property
GanttChangeReason | null
required
Name
activeId
Kind
property
Type
string | null
Requirement
required
Name
draftEnd
Kind
property
Type
number | null
Requirement
required
Name
draftStart
Kind
property
Type
number | null
Requirement
required
Name
focusedId
Kind
property
Type
string | null
Requirement
required
Name
originEnd
Kind
property
Type
number | null
Requirement
required
Name
originStart
Kind
property
Type
number | null
Requirement
required
Name
reason
Kind
property
Type
GanttChangeReason | null
Requirement
required

GanttController

interface
DeclarationView source
GanttControllerts
interface GanttController {
attach(service: GanttService): void;
beginPointer(detail: GanttPointerBegin): void;
destroy(): void;
}
Name
Kind
Type
Requirement
attach
method
(service: GanttService) => void
required
beginPointer
method
(detail: GanttPointerBegin) => void
required
destroy
method
() => void
required
Name
attach
Kind
method
Type
(service: GanttService) => void
Requirement
required
Name
beginPointer
Kind
method
Type
(detail: GanttPointerBegin) => void
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
DeclarationView source
GanttControllerHostts
interface GanttControllerHost {
readonly getTrack: (id: string) => GanttRectTarget | null;
readonly getWindow?: () => GanttWindowLike | null;
}
Name
Kind
Type
Requirement
getTrack
property
(id: string) => GanttRectTarget | null
required
getWindow
property
() => GanttWindowLike | null
optional
Name
getTrack
Kind
property
Type
(id: string) => GanttRectTarget | null
Requirement
required
Name
getWindow
Kind
property
Type
() => GanttWindowLike | null
Requirement
optional

GanttEvent

type
DeclarationView source
GanttEventts
type GanttEvent = {
readonly type: "FOCUS";
readonly id: string;
} | {
readonly type: "BLUR";
readonly id: string;
} | {
readonly type: "GRAB";
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: GanttChangeReason;
} | {
readonly type: "NUDGE";
readonly direction: -1 | 1;
} | {
readonly type: "DRAG";
readonly start: number;
readonly end: number;
} | {
readonly type: "DROP";
} | {
readonly type: "CANCEL";
};

GanttInput

type
DeclarationView source
GanttInputts
type GanttInput = {
/** Host-owned ranges. The machine never writes these back. */
readonly bars?: readonly GanttBarRange[];
/** Axis unit count. @default 4 */
readonly columnCount?: number;
/** Positive finite axis unit. @default 1 */
readonly step?: number;
/**
* When false, the shell is inert (live default). Styled callers without
* `getRowId` and a range callback pass false.
*/
readonly interactive?: boolean;
};
Name
Kind
Type
Requirement
Description
bars
property
readonly GanttBarRange[]
optional
Host-owned ranges. The machine never writes these back.
columnCount
property
number
optional
Axis unit count.
interactive
property
boolean
optional
When false, the shell is inert (live default). Styled callers without `getRowId` and a range callback pass false.
step
property
number
optional
Positive finite axis unit.
Name
bars
Kind
property
Type
readonly GanttBarRange[]
Requirement
optional
Description
Host-owned ranges. The machine never writes these back.
Name
columnCount
Kind
property
Type
number
Requirement
optional
Description
Axis unit count.
Name
interactive
Kind
property
Type
boolean
Requirement
optional
Description
When false, the shell is inert (live default). Styled callers without `getRowId` and a range callback pass false.
Name
step
Kind
property
Type
number
Requirement
optional
Description
Positive finite axis unit.

ganttMachine

value
DeclarationView source
ganttMachinets
export declare const ganttMachine: GanttMachine;

GanttMount

interface
DeclarationView source
GanttMountts
interface GanttMount {
readonly service: GanttService;
readonly connector: GanttApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
GanttService
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required

GanttPart

type
DeclarationView source
GanttPartts
type GanttPart = (typeof ganttAnatomy.parts)[number];

GanttPointerBegin

interface
DeclarationView source
GanttPointerBegints
interface GanttPointerBegin {
readonly id: string;
readonly start: number;
readonly end: number;
readonly clientX: number;
}
Name
Kind
Type
Requirement
clientX
property
number
required
end
property
number
required
id
property
string
required
start
property
number
required
Name
clientX
Kind
property
Type
number
Requirement
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttPointerLike

interface
DeclarationView source
GanttPointerLikets
interface GanttPointerLike {
readonly clientX: number;
}
Name
Kind
Type
Requirement
clientX
property
number
required
Name
clientX
Kind
property
Type
number
Requirement
required
DeclarationView source
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttRectLike

interface
DeclarationView source
GanttRectLikets
interface GanttRectLike {
readonly left: number;
readonly width: number;
}
Name
Kind
Type
Requirement
left
property
number
required
width
property
number
required
Name
left
Kind
property
Type
number
Requirement
required
Name
width
Kind
property
Type
number
Requirement
required

GanttRectTarget

interface
DeclarationView source
GanttRectTargetts
interface GanttRectTarget {
getBoundingClientRect(): GanttRectLike;
}
Name
Kind
Type
Requirement
getBoundingClientRect
method
() => GanttRectLike
required
Name
getBoundingClientRect
Kind
method
Type
() => GanttRectLike
Requirement
required
DeclarationView source
ganttSelectorsts
export declare const ganttSelectors: {
value: (snapshot: GanttSnapshot) => GanttStateValue;
focusedId: (snapshot: GanttSnapshot) => string | null;
activeId: (snapshot: GanttSnapshot) => string | null;
draftStart: (snapshot: GanttSnapshot) => number | null;
draftEnd: (snapshot: GanttSnapshot) => number | null;
};
Name
Kind
Type
Requirement
activeId
property
(snapshot: GanttSnapshot) => string | null
required
draftEnd
property
(snapshot: GanttSnapshot) => number | null
required
draftStart
property
(snapshot: GanttSnapshot) => number | null
required
focusedId
property
(snapshot: GanttSnapshot) => string | null
required
value
property
(snapshot: GanttSnapshot) => GanttStateValue
required
Name
activeId
Kind
property
Type
(snapshot: GanttSnapshot) => string | null
Requirement
required
Name
draftEnd
Kind
property
Type
(snapshot: GanttSnapshot) => number | null
Requirement
required
Name
draftStart
Kind
property
Type
(snapshot: GanttSnapshot) => number | null
Requirement
required
Name
focusedId
Kind
property
Type
(snapshot: GanttSnapshot) => string | null
Requirement
required
Name
value
Kind
property
Type
(snapshot: GanttSnapshot) => GanttStateValue
Requirement
required
DeclarationView source
GanttServicets
type GanttService = Service<GanttInput, GanttStateValue, GanttContext, GanttEvent, GanttCommand>;
DeclarationView source
GanttSnapshotts
type GanttSnapshot = Snapshot<GanttStateValue, GanttContext>;
DeclarationView source
GanttStateValuets
type GanttStateValue = "idle" | "grabbed" | "dragging";

GanttWindowLike

interface
DeclarationView source
GanttWindowLikets
interface GanttWindowLike {
addEventListener(type: string, listener: (event: GanttPointerLike) => void): void;
removeEventListener(type: string, listener: (event: GanttPointerLike) => void): void;
}
Name
Kind
Type
Requirement
addEventListener
method
(type: string, listener: (event: GanttPointerLike) => void) => void
required
removeEventListener
method
(type: string, listener: (event: GanttPointerLike) => void) => void
required
Name
addEventListener
Kind
method
Type
(type: string, listener: (event: GanttPointerLike) => void) => void
Requirement
required
Name
removeEventListener
Kind
method
Type
(type: string, listener: (event: GanttPointerLike) => void) => void
Requirement
required
DeclarationView source
isGanttIdInteractivets
declare function isGanttIdInteractive(input: GanttInput, id: string): boolean;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
id
parameter
string
required
return
return value
boolean
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
id
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a
DeclarationView source
isGanttInteractivets
declare function isGanttInteractive(input: GanttInput): boolean;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
return
return value
boolean
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

isGanttStepValid

function
DeclarationView source
isGanttStepValidts
declare function isGanttStepValid(step: number | undefined): boolean;
Name
Kind
Type
Requirement
step
parameter
number | undefined
required
return
return value
boolean
n/a
Name
step
Kind
parameter
Type
number | undefined
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

mountGantt

function
DeclarationView source
mountGanttts
declare function mountGantt(container: HTMLElement, options: MountGanttOptions): GanttMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountGanttOptions
required
return
return value
GanttMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountGanttOptions
Requirement
required
Name
return
Kind
return value
Type
GanttMount
Requirement
n/a

MountGanttOptions

interface
DeclarationView source
MountGanttOptionsts
interface MountGanttOptions extends GanttInput {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
readonly renderBar?: (element: HTMLElement, bar: GanttBarRange) => void;
}
Name
Kind
Type
Requirement
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
renderBar
property
(element: HTMLElement, bar: GanttBarRange) => void
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional
Name
renderBar
Kind
property
Type
(element: HTMLElement, bar: GanttBarRange) => void
Requirement
optional

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a

roundGanttUnit

function
DeclarationView source
roundGanttUnitts
declare function roundGanttUnit(value: number): number;
Name
Kind
Type
Requirement
value
parameter
number
required
return
return value
number
n/a
Name
value
Kind
parameter
Type
number
Requirement
required
Name
return
Kind
return value
Type
number
Requirement
n/a

runGanttCommand

function
DeclarationView source
runGanttCommandts
declare function runGanttCommand(command: GanttCommand, _scope: PartScope, options?: GanttConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
GanttCommand
required
_scope
parameter
PartScope
required
options
parameter
GanttConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
GanttCommand
Requirement
required
Name
_scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
GanttConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

stepOf

function
DeclarationView source
stepOfts
declare function stepOf(input: GanttInput): number;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
return
return value
number
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
return
Kind
return value
Type
number
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/ganttts
import { Bar, Gantt, List, Root, Row, Track } from "@grassroot/ui-headless-react/gantt";

Vue imports

@grassroot/ui-headless-vue/ganttts
<script setup lang="ts">
import { GanttBar, GanttList, GanttRoot, GanttRow, GanttTrack } from "@grassroot/ui-headless-vue/gantt";
</script>

Angular imports

@grassroot/ui-headless-angular/ganttts
import { Component } from "@angular/core";
import { GR_GANTT_DECLARATIONS } from "@grassroot/ui-headless-angular/gantt";
@Component({ standalone: true, imports: [GR_GANTT_DECLARATIONS], template: `<!-- compose the gantt parts here -->` })
export class Example {}

Svelte imports

@grassroot/ui-headless-svelte/ganttts
<script lang="ts">
import { GanttBar, GanttList, GanttRoot, GanttRow, GanttTrack } from "@grassroot/ui-headless-svelte/gantt";
</script>

Solid imports

@grassroot/ui-headless-solid/ganttts
import { GanttBar, GanttList, GanttRoot, GanttRow, GanttTrack } from "@grassroot/ui-headless-solid/gantt";

@grassroot/ui-headless-react/gantt

React adapter

19 exports
View source packages/ui-headless/react/src/gantt/index.ts

Bar

value
DeclarationView source
Barts
export declare const Bar: import("react").ForwardRefExoticComponent<GanttBarProps & 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

Gantt

value
DeclarationView source
Ganttts
export declare const Gantt: {
Root: import("react").ForwardRefExoticComponent<GanttRootProps & import("react").RefAttributes<HTMLDivElement>>;
List: import("react").ForwardRefExoticComponent<GanttListProps & import("react").RefAttributes<HTMLDivElement>>;
Row: import("react").ForwardRefExoticComponent<GanttRowProps & import("react").RefAttributes<HTMLDivElement>>;
Track: import("react").ForwardRefExoticComponent<GanttTrackProps & import("react").RefAttributes<HTMLDivElement>>;
Bar: import("react").ForwardRefExoticComponent<GanttBarProps & import("react").RefAttributes<HTMLDivElement>>;
};
Name
Kind
Type
Requirement
Bar
property
import("react").ForwardRefExoticComponent<GanttBarProps & import("react").RefAttributes<HTMLDivElement>>
required
List
property
import("react").ForwardRefExoticComponent<GanttListProps & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
import("react").ForwardRefExoticComponent<GanttRootProps & import("react").RefAttributes<HTMLDivElement>>
required
Row
property
import("react").ForwardRefExoticComponent<GanttRowProps & import("react").RefAttributes<HTMLDivElement>>
required
Track
property
import("react").ForwardRefExoticComponent<GanttTrackProps & import("react").RefAttributes<HTMLDivElement>>
required
Name
Bar
Kind
property
Type
import("react").ForwardRefExoticComponent<GanttBarProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
List
Kind
property
Type
import("react").ForwardRefExoticComponent<GanttListProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Root
Kind
property
Type
import("react").ForwardRefExoticComponent<GanttRootProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Row
Kind
property
Type
import("react").ForwardRefExoticComponent<GanttRowProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Track
Kind
property
Type
import("react").ForwardRefExoticComponent<GanttTrackProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required

GanttBarProps

interface
DeclarationView source
GanttBarPropsts
interface GanttBarProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly id: string;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

GanttContext

value
DeclarationView source
GanttContextts
export declare const GanttContext: import("react").Context<GanttContextValue | null>;
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

GanttContextValue

interface
DeclarationView source
GanttContextValuets
interface GanttContextValue {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required

GanttListProps

interface
DeclarationView source
GanttListPropsts
interface GanttListProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
DeclarationView source
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttRootProps

interface
DeclarationView source
GanttRootPropsts
interface GanttRootProps extends Omit<ComponentPropsWithoutRef<"div">, "onChange"> {
readonly asChild?: boolean;
readonly bars?: GanttInput["bars"];
readonly columnCount?: GanttInput["columnCount"];
readonly step?: GanttInput["step"];
readonly interactive?: GanttInput["interactive"];
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
bars
property
GanttInput["bars"]
optional
children
property
ReactNode
optional
columnCount
property
GanttInput["columnCount"]
optional
interactive
property
GanttInput["interactive"]
optional
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
step
property
GanttInput["step"]
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
bars
Kind
property
Type
GanttInput["bars"]
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
columnCount
Kind
property
Type
GanttInput["columnCount"]
Requirement
optional
Name
interactive
Kind
property
Type
GanttInput["interactive"]
Requirement
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional
Name
step
Kind
property
Type
GanttInput["step"]
Requirement
optional

GanttRowProps

interface
DeclarationView source
GanttRowPropsts
interface GanttRowProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly id: string;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

GanttTrackProps

interface
DeclarationView source
GanttTrackPropsts
interface GanttTrackProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
readonly id: string;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

List

value
DeclarationView source
Listts
export declare const List: import("react").ForwardRefExoticComponent<GanttListProps & 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

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<GanttRootProps & 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

Row

value
DeclarationView source
Rowts
export declare const Row: import("react").ForwardRefExoticComponent<GanttRowProps & 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

Track

value
DeclarationView source
Trackts
export declare const Track: import("react").ForwardRefExoticComponent<GanttTrackProps & 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

useGantt

function
DeclarationView source
useGanttts
declare function useGantt(input: GanttInput, options?: UseGanttOptions): UseGanttResult;
Name
Kind
Type
Requirement
input
parameter
GanttInput
required
options
parameter
UseGanttOptions
optional
return
return value
UseGanttResult
n/a
Name
input
Kind
parameter
Type
GanttInput
Requirement
required
Name
options
Kind
parameter
Type
UseGanttOptions
Requirement
optional
Name
return
Kind
return value
Type
UseGanttResult
Requirement
n/a

useGanttContext

function
DeclarationView source
useGanttContextts
declare function useGanttContext(partName: string): GanttContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
GanttContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
GanttContextValue
Requirement
n/a

UseGanttOptions

interface
DeclarationView source
UseGanttOptionsts
interface UseGanttOptions {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional

UseGanttResult

interface
DeclarationView source
UseGanttResultts
interface UseGanttResult {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly snapshot: GanttSnapshot;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
snapshot
property
GanttSnapshot
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
snapshot
Kind
property
Type
GanttSnapshot
Requirement
required

@grassroot/ui-headless-vue/gantt

Vue adapter

14 exports
View source packages/ui-headless/vue/src/gantt/index.ts

GanttBar

value
DeclarationView source
GanttBarts
export declare const GanttBar: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
id: {
type: StringConstructor;
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;
};
id: {
type: StringConstructor;
required: true;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
GanttContextKeyts
export declare const GanttContextKey: InjectionKey<GanttContextValue>;

GanttContextValue

interface
DeclarationView source
GanttContextValuets
interface GanttContextValue {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<GanttSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
snapshot
property
ShallowRef<GanttSnapshot>
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<GanttSnapshot>
Requirement
required

GanttList

value
DeclarationView source
GanttListts
export declare const GanttList: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttRoot

value
DeclarationView source
GanttRootts
export declare const GanttRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
bars: {
type: PropType<GanttInput["bars"]>;
default: undefined;
};
columnCount: {
type: PropType<number | undefined>;
default: undefined;
};
step: {
type: PropType<number | undefined>;
default: undefined;
};
interactive: {
type: PropType<boolean | undefined>;
default: undefined;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
rangeChange: (_detail: GanttRangeChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
bars: {
type: PropType<GanttInput["bars"]>;
default: undefined;
};
columnCount: {
type: PropType<number | undefined>;
default: undefined;
};
step: {
type: PropType<number | undefined>;
default: undefined;
};
interactive: {
type: PropType<boolean | undefined>;
default: undefined;
};
}>> & Readonly<{
onRangeChange?: ((_detail: GanttRangeChangeDetail) => any) | undefined;
}>, {
asChild: boolean;
bars: readonly import("@grassroot/ui-machines/gantt").GanttBarRange[] | undefined;
columnCount: number | undefined;
step: number | undefined;
interactive: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

GanttRow

value
DeclarationView source
GanttRowts
export declare const GanttRow: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
id: {
type: StringConstructor;
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;
};
id: {
type: StringConstructor;
required: true;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

GanttTrack

value
DeclarationView source
GanttTrackts
export declare const GanttTrack: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
id: {
type: StringConstructor;
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;
};
id: {
type: StringConstructor;
required: true;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a

toVueProps

function
DeclarationView source
toVuePropsts
declare function toVueProps(props: PartProps): Record<string, unknown>;
Name
Kind
Type
Requirement
props
parameter
PartProps
required
return
return value
Record<string, unknown>
n/a
Name
props
Kind
parameter
Type
PartProps
Requirement
required
Name
return
Kind
return value
Type
Record<string, unknown>
Requirement
n/a

useGantt

function
DeclarationView source
useGanttts
declare function useGantt(input: GanttInput | (() => GanttInput), options?: UseGanttOptions): UseGanttResult;
Name
Kind
Type
Requirement
input
parameter
GanttInput | (() => GanttInput)
required
options
parameter
UseGanttOptions
optional
return
return value
UseGanttResult
n/a
Name
input
Kind
parameter
Type
GanttInput | (() => GanttInput)
Requirement
required
Name
options
Kind
parameter
Type
UseGanttOptions
Requirement
optional
Name
return
Kind
return value
Type
UseGanttResult
Requirement
n/a

useGanttContext

function
DeclarationView source
useGanttContextts
declare function useGanttContext(partName: string): GanttContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
GanttContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
GanttContextValue
Requirement
n/a

UseGanttOptions

interface
DeclarationView source
UseGanttOptionsts
interface UseGanttOptions {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional

UseGanttResult

interface
DeclarationView source
UseGanttResultts
interface UseGanttResult {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<GanttSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
snapshot
property
ShallowRef<GanttSnapshot>
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<GanttSnapshot>
Requirement
required

@grassroot/ui-headless-angular/gantt

Angular adapter

15 exports
View source packages/ui-headless/angular/src/gantt/index.ts

applyProps

function

Applies a connector prop bag to a persistent Angular DOM element.

DeclarationView source
applyPropsts
export declare function applyProps(el: Element, props: PartProps, listeners: Map<string, EventListener>): void;
Name
Kind
Type
Requirement
el
parameter
Element
required
props
parameter
PartProps
required
listeners
parameter
Map<string, EventListener>
required
return
return value
void
n/a
Name
el
Kind
parameter
Type
Element
Requirement
required
Name
props
Kind
parameter
Type
PartProps
Requirement
required
Name
listeners
Kind
parameter
Type
Map<string, EventListener>
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

createGanttStore

function
DeclarationView source
createGanttStorets
export declare function createGanttStore(initialInput: GanttInput, options?: CreateGanttStoreOptions): GanttStore;
Name
Kind
Type
Requirement
initialInput
parameter
GanttInput
required
options
parameter
CreateGanttStoreOptions
optional
return
return value
GanttStore
n/a
Name
initialInput
Kind
parameter
Type
GanttInput
Requirement
required
Name
options
Kind
parameter
Type
CreateGanttStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
GanttStore
Requirement
n/a
DeclarationView source
CreateGanttStoreOptionsts
export interface CreateGanttStoreOptions {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional

One re-entrancy policy for every Angular store's zoneless commit nudge.

DeclarationView source
createReentrantSafeTickts
export declare function createReentrantSafeTick(appRef: ApplicationRef): () => void;
Name
Kind
Type
Requirement
appRef
parameter
ApplicationRef
required
return
return value
() => void
n/a
Name
appRef
Kind
parameter
Type
ApplicationRef
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a

GANTT_STORE

value
DeclarationView source
GANTT_STOREts
export declare const GANTT_STORE: InjectionToken<GanttStore>;
DeclarationView source
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttStore

interface
DeclarationView source
GanttStorets
export interface GanttStore {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: GanttInput): void;
bindRangeChange(handler: (detail: import("./use-gantt.js").GanttRangeChangeDetail) => void): void;
}
Name
Kind
Type
Requirement
bindRangeChange
method
(handler: (detail: import("./use-gantt.js").GanttRangeChangeDetail) => void) => void
required
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: GanttInput) => void
required
version
property
WritableSignal<number>
required
Name
bindRangeChange
Kind
method
Type
(handler: (detail: import("./use-gantt.js").GanttRangeChangeDetail) => void) => void
Requirement
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: GanttInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required
DeclarationView source
GR_GANTT_DECLARATIONSts
export declare const GR_GANTT_DECLARATIONS: readonly [typeof GrGanttRoot, typeof GrGanttList, typeof GrGanttRow, typeof GrGanttTrack, typeof GrGanttBar];

GrGanttBar

class
DeclarationView source
GrGanttBarts
export declare class GrGanttBar implements OnDestroy {
readonly barId: import("@angular/core").InputSignal<string | undefined>;
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
private registeredKey;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrGanttBar, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrGanttBar, "[grGanttBar]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
barId
property
import("@angular/core").InputSignal<string | undefined>
required
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrGanttBar, "[grGanttBar]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrGanttBar, never>
required
registeredKey
property
any
required
store
property
any
required
Name
barId
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrGanttBar, "[grGanttBar]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrGanttBar, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrGanttList

class
DeclarationView source
GrGanttListts
export declare class GrGanttList implements OnDestroy {
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrGanttList, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrGanttList, "[grGanttList]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrGanttList, "[grGanttList]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrGanttList, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrGanttList, "[grGanttList]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrGanttList, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrGanttRoot

class
DeclarationView source
GrGanttRootts
export declare class GrGanttRoot implements OnDestroy {
readonly bars: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/gantt").GanttBarRange[] | undefined>;
readonly columnCount: import("@angular/core").InputSignal<number | undefined>;
readonly step: import("@angular/core").InputSignal<number | undefined>;
readonly interactive: import("@angular/core").InputSignal<boolean | undefined>;
readonly rangeChange: import("@angular/core").OutputEmitterRef<GanttRangeChangeDetail>;
private readonly elementRef;
private readonly injector;
private readonly listeners;
private lastSynced;
readonly store: GanttStore;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrGanttRoot, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrGanttRoot, "gr-gantt-root", never, { "bars": { "alias": "bars"; "required": false; "isSignal": true; }; "columnCount": { "alias": "columnCount"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; }, { "rangeChange": "rangeChange"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
bars
property
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/gantt").GanttBarRange[] | undefined>
required
columnCount
property
import("@angular/core").InputSignal<number | undefined>
required
elementRef
property
any
required
injector
property
any
required
interactive
property
import("@angular/core").InputSignal<boolean | undefined>
required
lastSynced
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrGanttRoot, "gr-gantt-root", never, { "bars": { "alias": "bars"; "required": false; "isSignal": true; }; "columnCount": { "alias": "columnCount"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; }, { "rangeChange": "rangeChange"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrGanttRoot, never>
required
rangeChange
property
import("@angular/core").OutputEmitterRef<GanttRangeChangeDetail>
required
step
property
import("@angular/core").InputSignal<number | undefined>
required
store
property
GanttStore
required
Name
bars
Kind
property
Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/gantt").GanttBarRange[] | undefined>
Requirement
required
Name
columnCount
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
injector
Kind
property
Type
any
Requirement
required
Name
interactive
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
lastSynced
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<GrGanttRoot, "gr-gantt-root", never, { "bars": { "alias": "bars"; "required": false; "isSignal": true; }; "columnCount": { "alias": "columnCount"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; }, { "rangeChange": "rangeChange"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrGanttRoot, never>
Requirement
required
Name
rangeChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<GanttRangeChangeDetail>
Requirement
required
Name
step
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
store
Kind
property
Type
GanttStore
Requirement
required

GrGanttRow

class
DeclarationView source
GrGanttRowts
export declare class GrGanttRow implements OnDestroy {
readonly barId: import("@angular/core").InputSignal<string | undefined>;
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
private registeredKey;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrGanttRow, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrGanttRow, "[grGanttRow]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
barId
property
import("@angular/core").InputSignal<string | undefined>
required
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrGanttRow, "[grGanttRow]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrGanttRow, never>
required
registeredKey
property
any
required
store
property
any
required
Name
barId
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrGanttRow, "[grGanttRow]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrGanttRow, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrGanttTrack

class
DeclarationView source
GrGanttTrackts
export declare class GrGanttTrack implements OnDestroy {
readonly barId: import("@angular/core").InputSignal<string | undefined>;
private readonly store;
private readonly elementRef;
private readonly listeners;
private readonly consumerProps;
private registeredKey;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrGanttTrack, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrGanttTrack, "[grGanttTrack]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
barId
property
import("@angular/core").InputSignal<string | undefined>
required
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrGanttTrack, "[grGanttTrack]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrGanttTrack, never>
required
registeredKey
property
any
required
store
property
any
required
Name
barId
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrGanttTrack, "[grGanttTrack]", never, { "barId": { "alias": "barId"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrGanttTrack, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a
DeclarationView source
provideGanttStorets
export declare function provideGanttStore(): Provider;
Name
Kind
Type
Requirement
return
return value
Provider
n/a
Name
return
Kind
return value
Type
Provider
Requirement
n/a

@grassroot/ui-headless-svelte/gantt

Svelte adapter

14 exports
View source packages/ui-headless/svelte/src/gantt/index.ts

createGantt

function
DeclarationView source
createGanttts
export declare function createGantt(inputGetter: () => GanttInput, options?: UseGanttOptions): UseGanttResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => GanttInput
required
options
parameter
UseGanttOptions
optional
return
return value
UseGanttResult
n/a
Name
inputGetter
Kind
parameter
Type
() => GanttInput
Requirement
required
Name
options
Kind
parameter
Type
UseGanttOptions
Requirement
optional
Name
return
Kind
return value
Type
UseGanttResult
Requirement
n/a

GanttBar

value
DeclarationView source
GanttBarts
export declare const GanttBar: 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

GanttContextValue

interface
DeclarationView source
GanttContextValuets
export interface GanttContextValue {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
version
property
() => number
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

GanttList

value
DeclarationView source
GanttListts
export declare const GanttList: 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
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttRoot

value
DeclarationView source
GanttRootts
export declare const GanttRoot: 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

GanttRow

value
DeclarationView source
GanttRowts
export declare const GanttRow: 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

GanttTrack

value
DeclarationView source
GanttTrackts
export declare const GanttTrack: 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

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a

splitProps

function

Split the core prop bag, then apply Svelte-specific style/event handling.

DeclarationView source
splitPropsts
export declare function splitProps(props: PartProps): SplitProps;
Name
Kind
Type
Requirement
props
parameter
PartProps
required
return
return value
SplitProps
n/a
Name
props
Kind
parameter
Type
PartProps
Requirement
required
Name
return
Kind
return value
Type
SplitProps
Requirement
n/a

useGanttContext

function
DeclarationView source
useGanttContextts
export declare function useGanttContext(partName: string): GanttContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
GanttContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
GanttContextValue
Requirement
n/a

UseGanttOptions

interface
DeclarationView source
UseGanttOptionsts
export interface UseGanttOptions {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional

UseGanttResult

interface
DeclarationView source
UseGanttResultts
export interface UseGanttResult {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
version
property
() => number
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

wireEvents

function
DeclarationView source
wireEventsts
export declare function wireEvents(node: Element, params: {
events: Record<string, EventListener>;
ref?: (node: Element | null) => void;
}): {
update(next: typeof params): void;
destroy(): void;
};
Name
Kind
Type
Requirement
node
parameter
Element
required
params
parameter
{ events: Record<string, EventListener>; ref?: (node: Element | null) => void; }
required
return
return value
{ update(next: typeof params): void; destroy(): void; }
n/a
Name
node
Kind
parameter
Type
Element
Requirement
required
Name
params
Kind
parameter
Type
{ events: Record<string, EventListener>; ref?: (node: Element | null) => void; }
Requirement
required
Name
return
Kind
return value
Type
{ update(next: typeof params): void; destroy(): void; }
Requirement
n/a

@grassroot/ui-headless-solid/gantt

Solid adapter

18 exports
View source packages/ui-headless/solid/src/gantt/index.ts

GanttBar

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

GanttBarProps

interface
DeclarationView source
GanttBarPropsts
export interface GanttBarProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
readonly id: string;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
id
property
string
required
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

GanttContext

value
DeclarationView source
GanttContextts
export declare const GanttContext: import("solid-js").Context<GanttContextValue | undefined>;

GanttContextValue

interface
DeclarationView source
GanttContextValuets
export interface GanttContextValue {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly snapshot: Accessor<GanttSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
snapshot
property
Accessor<GanttSnapshot>
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<GanttSnapshot>
Requirement
required

GanttList

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

GanttListProps

interface
DeclarationView source
GanttListPropsts
export interface GanttListProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
DeclarationView source
GanttRangeChangeDetailts
interface GanttRangeChangeDetail {
readonly id: string;
readonly start: number;
readonly end: number;
readonly reason: "pointer" | "keyboard";
}
Name
Kind
Type
Requirement
end
property
number
required
id
property
string
required
reason
property
"pointer" | "keyboard"
required
start
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
reason
Kind
property
Type
"pointer" | "keyboard"
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

GanttRoot

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

GanttRootProps

interface
DeclarationView source
GanttRootPropsts
export interface GanttRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> {
readonly as?: AsProp;
readonly bars?: GanttInput["bars"];
readonly columnCount?: GanttInput["columnCount"];
readonly step?: GanttInput["step"];
readonly interactive?: GanttInput["interactive"];
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
bars
property
GanttInput["bars"]
optional
columnCount
property
GanttInput["columnCount"]
optional
interactive
property
GanttInput["interactive"]
optional
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
step
property
GanttInput["step"]
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
bars
Kind
property
Type
GanttInput["bars"]
Requirement
optional
Name
columnCount
Kind
property
Type
GanttInput["columnCount"]
Requirement
optional
Name
interactive
Kind
property
Type
GanttInput["interactive"]
Requirement
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional
Name
step
Kind
property
Type
GanttInput["step"]
Requirement
optional

GanttRow

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

GanttRowProps

interface
DeclarationView source
GanttRowPropsts
export interface GanttRowProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
readonly id: string;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
id
property
string
required
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

GanttTrack

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

GanttTrackProps

interface
DeclarationView source
GanttTrackPropsts
export interface GanttTrackProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
readonly id: string;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
id
property
string
required
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

projectGanttBars

function
DeclarationView source
projectGanttBarsts
declare function projectGanttBars<T extends {
readonly start: number;
readonly end: number;
}>(rows: readonly T[], getRowId?: (row: T, index: number) => string): GanttBarRange[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
optional
return
return value
GanttBarRange[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
optional
Name
return
Kind
return value
Type
GanttBarRange[]
Requirement
n/a

useGantt

function
DeclarationView source
useGanttts
export declare function useGantt(input: Accessor<GanttInput>, options?: UseGanttOptions): UseGanttResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<GanttInput>
required
options
parameter
UseGanttOptions
optional
return
return value
UseGanttResult
n/a
Name
input
Kind
parameter
Type
Accessor<GanttInput>
Requirement
required
Name
options
Kind
parameter
Type
UseGanttOptions
Requirement
optional
Name
return
Kind
return value
Type
UseGanttResult
Requirement
n/a

useGanttContext

function
DeclarationView source
useGanttContextts
export declare function useGanttContext(partName: string): GanttContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
GanttContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
GanttContextValue
Requirement
n/a

UseGanttOptions

interface
DeclarationView source
UseGanttOptionsts
export interface UseGanttOptions {
readonly onRangeChange?: (detail: GanttRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
onRangeChange
property
(detail: GanttRangeChangeDetail) => void
optional
Name
onRangeChange
Kind
property
Type
(detail: GanttRangeChangeDetail) => void
Requirement
optional

UseGanttResult

interface
DeclarationView source
UseGanttResultts
export interface UseGanttResult {
readonly service: GanttService;
readonly connector: GanttApi;
readonly scope: PartScope;
readonly snapshot: Accessor<GanttSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
GanttApi
required
scope
property
PartScope
required
service
property
GanttService
required
snapshot
property
Accessor<GanttSnapshot>
required
Name
connector
Kind
property
Type
GanttApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
GanttService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<GanttSnapshot>
Requirement
required