Interface Options<Component, ContextExternal>
Component extends SvelteComponent = SvelteComponent,
ContextExternal extends AbstractExternal = AbstractExternal,
> {
baseApplication?: string;
classes?: string[];
defaultCloseAnimation?: boolean;
dragDrop?: {
callbacks?: {
dragover?: Function;
dragstart?: Function;
drop?: Function;
};
dragSelector?: string;
dropSelector?: string;
}[];
draggable?: boolean;
filters?: SearchFilterConfiguration[];
focusAuto?: boolean;
focusKeep?: boolean;
focusSource?: A11yFocusSource;
focusTrap?: boolean;
headerButtonNoClose?: boolean;
headerButtonNoLabel?: boolean;
headerIcon?: string;
headerNoTitleMinimized?: boolean;
height?: string
| number;
id?: string;
left?: string | number;
maxHeight?: string | number;
maxWidth?: string | number;
minHeight?: string | number;
minimizable?: boolean;
minWidth?: string | number;
popOut?: boolean;
positionable?: boolean;
positionInitial?: InitialSystem;
positionOrtho?: boolean;
positionValidator?: ValidatorOption;
resizable?: boolean;
rotateX?: string | number;
rotateY?: string | number;
rotateZ?: string | number;
rotation?: string | number;
scale?: number;
scrollY?: string[];
sessionStorage?: WebStorage;
svelte: Dynamic<
Component,
{
ContextOmit: "application"
| "elementRootUpdate"
| "sessionStorage";
ContextShape: ContextExternal;
PropsOmit: "elementRoot" | "elementContent" | "elementTarget";
},
>;
tabs?: TabsOptions[];
template?: string;
title?: string;
top?: string
| number;
transformOrigin?: TransformOrigin;
width?: string | number;
}
Type Parameters
- Component extends SvelteComponent = SvelteComponent
- ContextExternal extends AbstractExternal = AbstractExternal
Hierarchy
- OptionsCore
- Options (View Summary)
Index
Properties
Properties
OptionalbaseApplication
A named "base application" which generates an additional hook
Optionalclasses
An array of CSS string classes to apply to the rendered HTML
OptionaldefaultCloseAnimation
If false the default slide close animation is not run.
OptionaldragDrop
Optionaldraggable
If true then application shells are draggable.
Optionalfilters
filters An array of SearchFilter configuration objects.
OptionalfocusAuto
When true auto-management of app focus is enabled.
OptionalfocusKeep
When focusAuto and focusKeep is true; keeps internal focus.
OptionalfocusSource
Defines A11yHelper focus source to apply when application closes.
@defaultValue: undefined
OptionalfocusTrap
When true focus trapping / wrapping is enabled keeping focus inside app.
OptionalheaderButtonNoClose
If true then the close header button is removed.
OptionalheaderButtonNoLabel
If true then header button labels are removed.
OptionalheaderIcon
Sets a header icon given an image URL.
OptionalheaderNoTitleMinimized
If true then header title is hidden when minimized.
Optionalheight
The default pixel height for app.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
Optionalid
The default CSS id to assign to the rendered HTML
Optionalleft
The default left offset position for app.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
OptionalmaxHeight
Assigned to position. Number specifying maximum window height.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
OptionalmaxWidth
Assigned to position. Number specifying maximum window width.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
OptionalminHeight
Assigned to position. Number specifying minimum window height.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
Optionalminimizable
Whether the rendered application can be minimized (popOut only)
OptionalminWidth
Assigned to position. Number specifying minimum window width.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
OptionalpopOut
Whether to display the application as a pop-out container
Optionalpositionable
If false then position.set does not take effect.
OptionalpositionInitial
A helper for initial position placement.
OptionalpositionOrtho
When true TJSPosition is optimized for orthographic use.
OptionalpositionValidator
A validator function or data or list of validators.
Optionalresizable
Whether the rendered application can be drag-resized (popOut only)
OptionalrotateX
Assigned to position. Number specifying the window rotation around the X-axis in degrees.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for values supported.
OptionalrotateY
Assigned to position. Number specifying the window rotation around the Y-axis in degrees.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for values supported.
OptionalrotateZ
Assigned to position. Number specifying the window rotation around the Z-axis in degrees.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for values supported.
Optionalrotation
Assigned to position. Number specifying the window rotation around the Z-axis in degrees. Alias for rotateZ.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for values supported.
Optionalscale
A transformation scale for the rendered HTML
OptionalscrollY
A list of unique CSS selectors which target containers that should have their vertical scroll positions preserved during a re-render.
OptionalsessionStorage
An instance of WebStorage (session) to share across SvelteApps. This is only required to share a WebStorage instance across multiple SvelteApps. By default, a unique #runtime/svelte/store/web-storage!TJSSessionStorage instance is created per SvelteApp.
svelte
Component,
{
ContextOmit: "application"
| "elementRootUpdate"
| "sessionStorage";
ContextShape: ContextExternal;
PropsOmit: "elementRoot" | "elementContent" | "elementTarget";
},
>
A Svelte configuration object defining the main component loaded.
Note: that svelte.class is required; this is due to type inference requirements by TypeScript.
Optionaltabs
Track Tab navigation handlers which are active for this Application
Optionaltemplate
The default HTML template path to render for this Application
Optionaltitle
A default window title string (popOut only)
Optionaltop
The default top offset position for app.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
OptionaltransformOrigin
By default, 'top / left' respects rotation when minimizing.
Optionalwidth
The default pixel height for app.
When defined as a string see TJSPosition.API.Data.TJSPositionDataRelative for relative values supported.
Options for SvelteApp including the
svelteproperty which defines the Svelte component to load as the "application shell".Note: Unlike standard Svelte component loading any
contextprovided is loaded as additional data into the#externalcontext key along with data such as the outer application instance reference. This allows one to extend the SvelteApp.Context.External interface with additional data that you are loading and use one type to conveniently retrieve all external context data inside a Svelte component.Note that the
svelteconfiguration includes dynamic options to definecontextandpropsas afunctionas well as anobject. There are times when thecontextandpropdata to load needs to come from data associated with the instance of the application. When defining the configuration from the overloaded static accessor SvelteApp.defaultOptions you may use a standard function IEfunction() {}forcontextorprops. WhenSvelteApploads the component these functions will be invoked with thethisreference of the actual instance allowing association of instance data from within a static context.