Class KeyStore
Index
Constructors
Methods
Constructors
constructor
- new
Key (keyNames?, options?): KeyStoreStore Parameters
OptionalkeyNames: Iterable<string, any, any>Optionaloptions: KeyStoreOptionsOptional parameters
-
Returns KeyStore
Methods
Protected_updateSubscribers
- _update
Subscribers (): void ProtectedUpdates subscribers.
+Class KeyStore
Provides a readable store to track keys actively pressed. KeyStore is designed to be used with the +keyforward action.
+Index
Constructors
Methods
Constructors
constructor
- new
Key (keyNames?, options?): KeyStoreStore Parameters
OptionalkeyNames: Iterable<string, any, any>Optionaloptions: KeyStoreOptionsOptional parameters
+
Returns KeyStore
Returns void
remove
Key set
Options - set
Options (options): void Update options.
-Parameters
- options: KeyStoreOptions
Options to set.
-
Returns void
- options: KeyStoreOptions
subscribe
- subscribe(handler): Unsubscriber
Parameters
- handler: Subscriber<KeyStore>
Callback function that is invoked on update / +
Parameters
- options: KeyStoreOptions
Options to set.
+
Returns void
- options: KeyStoreOptions
subscribe
- subscribe(handler): Unsubscriber
Parameters
- handler: Subscriber<KeyStore>
Callback function that is invoked on update / changes.
Returns Unsubscriber
Unsubscribe function.
- handler: Subscriber<KeyStore>
value
- value(key): number
Parameters
- key: string
key or key code to lookup.
diff --git a/docs/classes/_runtime_util_browser.ImageData.html b/docs/classes/_runtime_util_async.ImageData.html similarity index 72% rename from docs/classes/_runtime_util_browser.ImageData.html rename to docs/classes/_runtime_util_async.ImageData.html index 483511a0..1fcbb85f 100644 --- a/docs/classes/_runtime_util_browser.ImageData.html +++ b/docs/classes/_runtime_util_async.ImageData.html @@ -1,8 +1,8 @@ImageData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class ImageData
Provides utility functions for retrieving data about images.
-Index
Constructors
Methods
Methods
StaticgetDimensions - get
Dimensions (urls, options?): Promise<{
fulfilled: {
height: number;
url: string;
width: number;
}[];
rejected: {
url: string;
}[];
}> Loads given URLs into image elements returning those that resolved with width & height dimensions. This is useful +
Class ImageData
Provides utility functions for retrieving data about images.
+Index
Constructors
Methods
Methods
StaticgetDimensions - get
Dimensions (urls, options?): Promise<{
fulfilled: {
height: number;
url: string;
width: number;
}[];
rejected: {
url: string;
}[];
}> Loads given URLs into image elements returning those that resolved with width & height dimensions. This is useful when the size of an image is necessary before usage.
Parameters
- urls: string | {
url?: string;
} | Iterable<string | {
url?: string;
}, any, any>A list of image URLS to load or object with an
diff --git a/docs/classes/_runtime_util_html_striptags.StateMachine.html b/docs/classes/_runtime_util_html_striptags.StateMachine.html new file mode 100644 index 00000000..80971306 --- /dev/null +++ b/docs/classes/_runtime_util_html_striptags.StateMachine.html @@ -0,0 +1,4 @@ +urlproperty.StateMachine | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Class StateMachine
Index
Constructors
Methods
consume +Constructors
constructor
- new
State (partialOptions?): StateMachineMachine Parameters
OptionalpartialOptions: Partial<StateMachineOptions>
Returns StateMachine
FVTTFilePickerControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class FVTTFilePickerControl
Provides managed control of the Foundry globalThis.FilePicker app simplifying asynchronous use cases. While the stock +
Class FVTTFilePickerControl
Provides managed control of the Foundry globalThis.FilePicker app simplifying asynchronous use cases. While the stock FilePicker provides a callback it is not easy to make it asynchronous given that a user can close the app. FVTTFilePickerControl enables a fully asynchronous workflow controlling one FilePicker instance at a time. When -FVTTFilePickerControl.browse is invoked any previous FilePicker instance is closed and Promise resolved.
+FVTTFilePickerControl.browse is invoked any previous FilePicker instance is closed and Promise resolved.Additionally, the file picker app is modified to work in modal context w/ TJSGlassPane along with any managing associated dialog instances displayed. A very powerful capability is to display a modal FilePicker app instance.
-For extended options available for FVTTFilePickerControl.browse see FVTTFilePickerBrowseOptions. +
For extended options available for FVTTFilePickerControl.browse see FVTTFilePickerBrowseOptions. It is highly recommended that you provide a unique CSS ID for each file picker instance invoked. -A use case where you should use FVTTFilePickerControl is to invoke FVTTFilePickerControl.close +A use case where you should use FVTTFilePickerControl is to invoke FVTTFilePickerControl.close in an
onDestroySvelte callback to close any open file picker apps associated w/ UI layout components you design.A demo example is available in
@@ -18,17 +18,17 @@essential-svelte-esm: https://github.com/typhonjs-fvtt-demo/essential-svelte-esm- TJSFileIconButton - Uses TJSIconButton for display.
- TJSFileSlotButton - Provides a slotted button where you can provide any containing content.
-Index
Constructors
constructor
- new FVTTFile
Picker (): FVTTFilePickerControlControl Returns FVTTFilePickerControl
Index
Constructors
constructor
- new FVTTFile
Picker (): FVTTFilePickerControlControl Returns FVTTFilePickerControl
Accessors
StaticcanBrowse - get canBrowse(): boolean
Returns boolean
Test if the current user can browse files.
Methods
StaticbringTo Top Staticbrowse- browse(options?, event?): Promise<string>
Creates a new Foundry FilePicker app to browse and return a file path selection.
-Parameters
Optionaloptions: FVTTFilePickerBrowseOptionsFVTTFilePickerControl browse options. This may also include any +
Parameters
Optionaloptions: FVTTFilePickerBrowseOptionsFVTTFilePickerControl browse options. This may also include any Application options.
Optionalevent: MouseEvent | KeyboardEventAn event to inspect for focus management when a modal file picker is launched.
diff --git a/docs/classes/_standard_application_sidebar.FVTTSidebarControl.html b/docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html similarity index 77% rename from docs/classes/_standard_application_sidebar.FVTTSidebarControl.html rename to docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html index 5ae10f2d..5d92d524 100644 --- a/docs/classes/_standard_application_sidebar.FVTTSidebarControl.html +++ b/docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html @@ -1,11 +1,11 @@FVTTSidebarControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class FVTTSidebarControl
Provides the ability to mount and control Svelte component based sidebar panels & tabs in the Foundry sidebar.
+Class FVTTSidebarControl
Provides the ability to mount and control Svelte component based sidebar panels & tabs in the Foundry sidebar.
The nice aspect about FVTTSidebarControl is that all you have to provide is the sidebar component and the rest is handled for you including automatically widening the width of the sidebar to fit the new sidebar tab. Also by default an adhoc SvelteApplication is configured to display the sidebar when popped out automatically without the need to associate an app instance.
-To add a new sidebar tab schedule one or more invocations of FVTTSidebarControl.add in a
setuphook. You +To add a new sidebar tab schedule one or more invocations of FVTTSidebarControl.add in a
setuphook. You must add all sidebars in thesetuphook before the main Foundry sidebar renders. Please review all the expanded options available in the configuration object passed to theaddmethod. At minimum, you need to provide a uniqueid,icon, andsvelteconfiguration object. You almost always will want to providebeforeIdreferencing @@ -30,11 +30,11 @@
-There is a method to remove an existing stock Foundry sidebar FVTTSidebarControl.remove. It takes +
There is a method to remove an existing stock Foundry sidebar FVTTSidebarControl.remove. It takes an
idfield that must be one of the existing Foundry sidebar IDs to remove: chat', 'combat', 'scenes', 'actors', 'items', 'journal', 'tables', 'cards', 'playlists', 'compendium', and 'settings'.
-There is a method to replace an existing stock Foundry sidebar FVTTSidebarControl.replace. It takes +
There is a method to replace an existing stock Foundry sidebar FVTTSidebarControl.replace. It takes the same data as the
addmethod, butidmust be one of the existing Foundry sidebar IDs to replace: chat', 'combat', 'scenes', 'actors', 'items', 'journal', 'tables', 'cards', 'playlists', 'compendium', and 'settings'.Both the
addandreplacemethods have a data fieldmergeAppImplthat provides the base implementation for the @@ -43,29 +43,29 @@ sidebar app implementation. It is recommended that you implement this API as part of the control / model code passed to the Svelte sidebar component and also set tomergeAppImpl.
-The FVTTSidebarControl.get method allows you to retrieve the associated FVTTSidebarEntry for a given +
The FVTTSidebarControl.get method allows you to retrieve the associated FVTTSidebarEntry for a given sidebar by ID allowing access to the configuration data, popout app, and wrapper components that mount the sidebar.
-The FVTTSidebarControl.wait returns a Promise that is resolved after all sidebars have been initialized. +
The FVTTSidebarControl.wait returns a Promise that is resolved after all sidebars have been initialized. allowing handling any special setup as necessary.
Example
-Minimal setup
Hooks.once('setup', () =>
{
FVTTSidebarControl.add({
beforeId: 'items', // Place new tab before the 'items' tab.
id: 'test', // A unique CSS ID.
icon: 'fas fa-dice-d10', // FontAwesome icon.
condition: () => game.user.isGM, // Optional boolean / function to conditionally run the sidebar action.
title: 'Test Directory', // Title of popout sidebar app; can be language string.
tooltip: 'Tests', // Tooltip for sidebar tab.
svelte: { // A Svelte configuration object.
class: TestTab // A Svelte component.
}
});
});Constructors
constructor
- new FVTTSidebar
Control (): FVTTSidebarControl Returns FVTTSidebarControl
Methods
Staticadd- add(sidebarData): void
Adds a new Svelte powered sidebar tab / panel.
-Parameters
- sidebarData: FVTTSidebarAddData
The configuration object for a Svelte sidebar,
-
Returns void
- sidebarData: FVTTSidebarAddData
Staticget- get(id): FVTTSidebarEntry
Returns a loaded and configured sidebar entry by ID.
+
Constructors
constructor
- new FVTTSidebar
Control (): FVTTSidebarControl Returns FVTTSidebarControl
Methods
Staticadd- add(sidebarData): void
Adds a new Svelte powered sidebar tab / panel.
+Parameters
- sidebarData: FVTTSidebarAddData
The configuration object for a Svelte sidebar,
+
Returns void
- sidebarData: FVTTSidebarAddData
Staticget- get(id): FVTTSidebarEntry
Returns a loaded and configured sidebar entry by ID.
Parameters
- id: string
The ID of the sidebar to retrieve.
-
Returns FVTTSidebarEntry
The sidebar entry.
+- id: string
Returns FVTTSidebarEntry
The sidebar entry.
Staticremove- remove(sidebarData): void
Removes an existing sidebar tab / panel.
-Parameters
- sidebarData: FVTTSidebarRemoveData
The configuration object to remove a Svelte sidebar.
+Parameters
- sidebarData: FVTTSidebarRemoveData
The configuration object to remove a Svelte sidebar.
Returns void
- sidebarData: FVTTSidebarRemoveData
Staticreplace- replace(sidebarData): void
Replaces an existing sidebar tab / panel with a new Svelte powered sidebar.
-Parameters
- sidebarData: FVTTSidebarReplaceData
The configuration object to replace a core sidebar with a Svelte +
Parameters
- sidebarData: FVTTSidebarReplaceData
The configuration object to replace a core sidebar with a Svelte sidebar.
Returns void
- sidebarData: FVTTSidebarReplaceData
Staticwait- wait(): Promise<any>
Provides a Promise that is resolved after all added sidebars are initialized. This is useful when additional setup or configuration of sidebars needs to be performed after sidebar initialization.
diff --git a/docs/classes/_standard_component_dom.TJSFocusWrap.html b/docs/classes/_standard_component_dom.TJSFocusWrap.html deleted file mode 100644 index 863dda7f..00000000 --- a/docs/classes/_standard_component_dom.TJSFocusWrap.html +++ /dev/null @@ -1,18 +0,0 @@ -TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class TJSFocusWrap
Provides a component to wrap focus to the first focusable element in the given
-elementRootprop. Place this -component as the last child inelementRoot.- ---
-- - Hierarchy
---- SvelteComponent<TJSFocusWrap.Props, TJSFocusWrap.Events, TJSFocusWrap.Slots>
- TJSFocusWrap (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSFocus
Wrap (options): TJSFocusWrap Parameters
- options: ComponentConstructorOptions<TJSFocusWrap.Props>
Returns TJSFocusWrap
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSFocusWrap.Props>
Returns void
TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Class TJSFocusWrap
Provides a component to wrap focus to the first focusable element in the given
+elementRootprop. Place this +component as the last child inelementRoot.+ +++
++ + Hierarchy
+++- SvelteComponent<TJSFocusWrap.Props, TJSFocusWrap.Events, TJSFocusWrap.Slots>
- TJSFocusWrap (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSFocus
Wrap (options): TJSFocusWrap Parameters
- options: ComponentConstructorOptions<TJSFocusWrap.Props>
Returns TJSFocusWrap
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSFocusWrap.Props>
Returns void
TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class TJSPositionControlLayer
TODO: Add description
-- ---
-- - Hierarchy
---- SvelteComponent<TJSPositionControlLayer.Props, TJSPositionControlLayer.Events, TJSPositionControlLayer.Slots>
- TJSPositionControlLayer (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSPosition
Control (options): TJSPositionControlLayerLayer Parameters
Returns TJSPositionControlLayer
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSPositionControlLayer.Props>
Returns void
TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Class TJSSideSlideLayer
Provides a component to display an absolutely positioned side layer in a parent element featuring a column of -icons that slide out panels defined as Svelte components.
-- ---
-- - Hierarchy
---- SvelteComponent<TJSSideSlideLayer.Props, TJSSideSlideLayer.Events, TJSSideSlideLayer.Slots>
- TJSSideSlideLayer (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSSide
Slide (options): TJSSideSlideLayerLayer Parameters
Returns TJSSideSlideLayer
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSSideSlideLayer.Props>
Returns void
TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Class TJSPositionControlLayer
TODO: Add description
++ +++
++ + Hierarchy
+++- SvelteComponent<TJSPositionControlLayer.Props, TJSPositionControlLayer.Events, TJSPositionControlLayer.Slots>
- TJSPositionControlLayer (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSPosition
Control (options): TJSPositionControlLayerLayer Parameters
Returns TJSPositionControlLayer
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSPositionControlLayer.Props>
Returns void
TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Class TJSSideSlideLayer
Provides a component to display an absolutely positioned side layer in a parent element featuring a column of +icons that slide out panels defined as Svelte components.
++ +++
++ + Hierarchy
+++- SvelteComponent<TJSSideSlideLayer.Props, TJSSideSlideLayer.Events, TJSSideSlideLayer.Slots>
- TJSSideSlideLayer (view full)
Index
Constructors
Methods
Constructors
constructor
- new TJSSide
Slide (options): TJSSideSlideLayerLayer Parameters
Returns TJSSideSlideLayer
Methods
$destroy
$on
- $on<K>(type, callback): (() => void)
Type Parameters
Parameters
- type: K
- callback: ((e: CustomEvent<any>) => void)
- (e): void
Parameters
- e: CustomEvent<any>
Returns void
Returns (() => void)
- (): void
Returns void
$set
- $set(props): void
Parameters
- props: Partial<TJSSideSlideLayer.Props>
Returns void
Typing this makes it possible for IDEs like VS Code with the Svelte extension to provide intellisense and to use the component like this in a Svelte file with TypeScript:
-
+-- <script lang="ts">
import { MyComponent } from "component-library";
</script>
<MyComponent foo={'bar'} /> +- SvelteComponent<TJSFocusWrap.Props, TJSFocusWrap.Events, TJSFocusWrap.Slots>
Type Parameters
@@ -22,7 +21,7 @@Hierarchy
-+- SvelteComponent_1<Props, Events>
- SvelteComponent (view full)
- ApplicationShell
- EmptyApplicationShell
- TJSApplicationShell
- TJSGlassPane
- TJSIconButton
- TJSSlotButton
- TJSToggleIconButton
- TJSColordButton
- TJSColordPicker
- TJSScrollContainer
- TJSFocusWrap
- TJSIconFolder
- TJSSvgFolder
- TJSButton
- TJSInput
- TJSInputCheckbox
- TJSInputNumber
- TJSInputText
- TJSSelect
- TJSContentEdit
- TJSProseMirror
- TJSTinyMCE
- TJSFileButton
- TJSFileIconButton
- TJSFileSlotButton
- TJSSettingsEdit
- TJSSettingsSwap
- TJSThemeEditor
- TJSSlotLabel
- TJSToggleLabel
- TJSPositionControlLayer
- TJSSideSlideLayer
- TJSMediaContent
- TJSMenu
- SvelteComponentTyped
- SvelteComponent (view full)
- SvelteComponent_1<Props, Events>
- SvelteComponent (view full)
- ApplicationShell
- EmptyApplicationShell
- TJSApplicationShell
- TJSGlassPane
- TJSIconButton
- TJSSlotButton
- TJSToggleIconButton
- TJSColordButton
- TJSColordPicker
- TJSScrollContainer
- TJSFocusWrap
- TJSIconFolder
- TJSSvgFolder
- TJSButton
- TJSInput
- TJSInputCheckbox
- TJSInputNumber
- TJSInputText
- TJSSelect
- TJSContentEdit
- TJSProseMirror
- TJSTinyMCE
- TJSFileButton
- TJSFileIconButton
- TJSFileSlotButton
- TJSSettingsEdit
- TJSSettingsSwap
- TJSThemeEditor
- TJSSlotLabel
- TJSToggleLabel
- TJSPositionControlLayer
- TJSSideSlideLayer
- TJSMediaContent
- TJSMenu
- SvelteComponentTyped
- SvelteComponent (view full)
- sidebarData: FVTTSidebarReplaceData
Indexable
- [prop: string]: any
Index
Constructors
Methods
$destroy diff --git a/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html b/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html deleted file mode 100644 index a3c1d1cd..00000000 --- a/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html +++ /dev/null @@ -1,4 +0,0 @@ -sanitizeWithVideo | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function sanitizeWithVideo
- sanitize
With (dirty): anyVideo Provides a sanitize method that allows 'iframe' but only with sources from YouTube and Vimeo.
-Parameters
- dirty: string | Node
The content to sanitize.
-
Returns any
- dirty: string | Node
DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function DOMPurify
- DOMPurify(root): {
isSupported: boolean;
removed: any[];
version: string;
addHook(entryPoint: string, hookFunction: Function): void;
clearConfig(): void;
isValidAttribute(tag: string, attr: string, value: string): boolean;
removeAllHooks(): void;
removeHook(entryPoint: string): Function;
removeHooks(entryPoint: string): void;
sanitize(dirty: string | Node, ...args: any[]): any;
setConfig(...args: any[]): void;
(root: any): any;
} Parameters
- root: any
Returns {
isSupported: boolean;
removed: any[];
version: string;
addHook(entryPoint: string, hookFunction: Function): void;
clearConfig(): void;
isValidAttribute(tag: string, attr: string, value: string): boolean;
removeAllHooks(): void;
removeHook(entryPoint: string): Function;
removeHooks(entryPoint: string): void;
sanitize(dirty: string | Node, ...args: any[]): any;
setConfig(...args: any[]): void;
(root: any): any;
}- (root): any
Parameters
- root: any
Returns any
is
Supported : booleanremoved: any[]
Array of elements that DOMPurify removed during sanitation. -Empty if nothing was removed.
-version: string
Version label, exposed for easier checks -if DOMPurify is up to date or not
-add
Hook :function- add
Hook (entryPoint, hookFunction): void AddHook -Public method to add DOMPurify hooks
-Parameters
- entryPoint: string
entry point for the hook to add
- - hookFunction: Function
function to execute
-
Returns void
- entryPoint: string
- add
clear
Config :functionis
Valid :functionAttribute - is
Valid (tag, attr, value): booleanAttribute Public method to check if an attribute value is valid. -Uses last set config, if any. Otherwise, uses config defaults. -isValidAttribute
-Parameters
- tag: string
Tag name of containing element.
- - attr: string
Attribute name.
- - value: string
Attribute value.
-
Returns boolean
Returns true if
-valueis valid. Otherwise, returns false.- tag: string
- is
remove
All :functionHooks remove
Hook :functionremove
Hooks :functionsanitize:function
- sanitize(dirty, ...args): any
Sanitize -Public method providing core sanitation functionality
-Parameters
- dirty: string | Node
string or DOM node
- Rest...args: any[]
Returns any
- dirty: string | Node
set
Config :function
keyforward | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function keyforward
- keyforward(node, keyTarget): ActionReturn<{
keydown: ((event: KeyboardEvent) => void);
keyup: ((event: KeyboardEvent) => void);
}> Provides an action to forward on key down & up events. This can be any object that has associated
+keydownand +keyupmethods. See KeyStore for a store implementation.Parameters
- node: HTMLElement
Target element.
+ - keyTarget: {
keydown: ((event: KeyboardEvent) => void);
keyup: ((event: KeyboardEvent) => void);
}An object +to forward events key down / up events to as pressed.
+keydown: ((event: KeyboardEvent) => void)
- (event): void
Parameters
- event: KeyboardEvent
Returns void
keyup: ((event: KeyboardEvent) => void)
- (event): void
Parameters
- event: KeyboardEvent
Returns void
Returns ActionReturn<{
keydown: ((event: KeyboardEvent) => void);
keyup: ((event: KeyboardEvent) => void);
}>Action lifecycle methods.
+- node: HTMLElement
keyforward | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -\ No newline at end of file diff --git a/docs/functions/_runtime_util_browser.striptags.html b/docs/functions/_runtime_util_browser.striptags.html deleted file mode 100644 index f3cb09df..00000000 --- a/docs/functions/_runtime_util_browser.striptags.html +++ /dev/null @@ -1,2 +0,0 @@ -Function keyforward
- keyforward(node, keyStore): ActionReturn<KeyStore>
Provides an action to forward on key down & up events. This can be any object that has associated
+keydownand -keyupmethods. See KeyStore for a store implementation.useTinykeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function useTinykeys
- use
Tinykeys (node, data): ActionReturn<UseTinykeysData> Provides an action to use
tinykeys.Parameters
- node: HTMLElement
Target element.
- - keyStore: KeyStore
KeyStore to forward events key down / up events to...
-
Returns ActionReturn<KeyStore>
Action lifecycle methods.
+- node: HTMLElement
- data: UseTinykeysData
An object to forward events key down / up events to as pressed.
+Returns ActionReturn<UseTinykeysData>
Action lifecycle methods.
- use
striptags | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function striptags
- striptags(text, options?): string
Parameters
- text: string
Optionaloptions: Partial<StateMachineOptions>
Returns string
createKeybindingsHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function createKeybindingsHandler
- create
Keybindings (keyBindingMap, options?): EventListenerHandler Creates an event listener for handling keybindings.
-Parameters
- keyBindingMap: KeyBindingMap
Optionaloptions: KeyBindingHandlerOptions
Returns EventListener
Example
import { createKeybindingsHandler } from "../src/keybindings"
let handler = createKeybindingsHandler({
"Shift+d": () => {
alert("The 'Shift' and 'd' keys were pressed at the same time")
},
"y e e t": () => {
alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
},
"$mod+d": () => {
alert("Either 'Control+d' or 'Meta+d' were pressed")
},
})
window.addEvenListener("keydown", handler) +Function createKeybindingsHandler
- create
Keybindings (keyBindingMap, options?): EventListenerHandler Creates an event listener for handling keybindings.
+Parameters
- keyBindingMap: KeyBindingMap
Optionaloptions: KeyBindingHandlerOptions
Returns EventListener
Example
import { createKeybindingsHandler } from "../src/keybindings"
let handler = createKeybindingsHandler({
"Shift+d": () => {
alert("The 'Shift' and 'd' keys were pressed at the same time")
},
"y e e t": () => {
alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
},
"$mod+d": () => {
alert("Either 'Control+d' or 'Meta+d' were pressed")
},
})
window.addEvenListener("keydown", handler)
matchKeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function matchKeyBindingPress
- match
Key (event, __namedParameters): booleanBinding Press This tells us if a single keyboard event matches a single keybinding press.
+Parameters
- event: KeyboardEvent
- __namedParameters: KeyBindingPress
Returns boolean
parseKeybinding | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function parseKeybinding
- parse
Keybinding (str): KeyBindingPress[] Parses a "Key Binding String" into its parts
+grammar =
+<sequence>+= <press> <press> <press> ...+= <key>or<mods>+<key>+= <mod>+<mod>+...+= <KeyboardEvent.key>or<KeyboardEvent.code>(case-insensitive) += (<regex>)->/^<regex>$/(case-sensitive)Parameters
- str: string
Returns KeyBindingPress[]
tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function tinykeys
- tinykeys(target, keyBindingMap, __namedParameters?): (() => void)
Subscribes to keybindings.
+Function tinykeys
- tinykeys(target, keyBindingMap, __namedParameters?): (() => void)
Subscribes to keybindings.
Returns an unsubscribe method.
-Parameters
- target: HTMLElement | Window
- keyBindingMap: KeyBindingMap
Optional__namedParameters: KeyBindingOptions
Returns (() => void)
- (): void
Returns void
Example
import { tinykeys } from "../src/tinykeys"
tinykeys(window, {
"Shift+d": () => {
alert("The 'Shift' and 'd' keys were pressed at the same time")
},
"y e e t": () => {
alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
},
"$mod+d": () => {
alert("Either 'Control+d' or 'Meta+d' were pressed")
},
}) +Parameters
- target: HTMLElement | Window
- keyBindingMap: KeyBindingMap
Optional__namedParameters: KeyBindingOptions
Returns (() => void)
- (): void
Returns void
Example
import { tinykeys } from "../src/tinykeys"
tinykeys(window, {
"Shift+d": () => {
alert("The 'Shift' and 'd' keys were pressed at the same time")
},
"y e e t": () => {
alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
},
"$mod+d": () => {
alert("Either 'Control+d' or 'Meta+d' were pressed")
},
})
matchKeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function matchKeyBindingPress
- match
Key (event, __namedParameters): booleanBinding Press This tells us if a single keyboard event matches a single keybinding press.
-Parameters
- event: KeyboardEvent
- __namedParameters: KeyBindingPress
Returns boolean
parseKeybinding | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function parseKeybinding
- parse
Keybinding (str): KeyBindingPress[] Parses a "Key Binding String" into its parts
-grammar =
-<sequence>-= <press> <press> <press> ...-= <key>or<mods>+<key>-= <mod>+<mod>+...-= <KeyboardEvent.key>or<KeyboardEvent.code>(case-insensitive) -= (<regex>)->/^<regex>$/(case-sensitive)Parameters
- str: string
Returns KeyBindingPress[]
processHTML | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function processHTML
- processHTML(opts): string
Processes the given HTML by creating by running a CSS selector query with all matched elements being passed through +
Function processHTML
- processHTML(opts): string
Processes the given HTML by creating by running a CSS selector query with all matched elements being passed through the provided
processfunction.Parameters
- opts: {
containerElement?: string;
firstMatchOnly?: boolean;
html: string;
namespaceURI?: string;
process: ((HTMLElement: any) => void);
selector: string;
}Options
OptionalcontainerElement ?: stringUse a specific container element.
diff --git a/docs/functions/_runtime_util_html_striptags.striptags.html b/docs/functions/_runtime_util_html_striptags.striptags.html new file mode 100644 index 00000000..aef0c5a0 --- /dev/null +++ b/docs/functions/_runtime_util_html_striptags.striptags.html @@ -0,0 +1,2 @@ +striptags | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function striptags
- striptags(text, options?): string
Parameters
- text: string
Optionaloptions: Partial<StateMachineOptions>
Returns string
animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function animate
- animate(opts?): Action
Defines an
+Element.animateanimation from provided keyframes and options.animateWAAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Function animateWAAPI
- animateWAAPI(opts?): Action
Defines an
Element.animateanimation from provided keyframes and options.Parameters
Optionalopts: {
debounce?: number;
duration?: number;
event?: string;
keyframes: object | any[];
options?: object;
}Optional parameters.
Optionaldebounce?: numberAdd a debounce to incoming events in milliseconds.
Optionalduration?: numberDuration in milliseconds.
diff --git a/docs/functions/_runtime_svelte_action_animate.composable.html b/docs/functions/_standard_action_animate_composable.composable.html similarity index 80% rename from docs/functions/_runtime_svelte_action_animate.composable.html rename to docs/functions/_standard_action_animate_composable.composable.html index be44dfe4..9e09a06b 100644 --- a/docs/functions/_runtime_svelte_action_animate.composable.html +++ b/docs/functions/_standard_action_animate_composable.composable.html @@ -1,5 +1,5 @@composable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function composable
- composable(...actions): Action<HTMLElement, any>
Combines multiple composable actions.
+Function composable
- composable(...actions): Action<HTMLElement, any>
Combines multiple composable actions.
Note: The update function passes the same variable to all update functions of each action.
Parameters
Rest...actions: Action<HTMLElement, undefined, Record<never, any>>[]One or more composable action functions to combine.
Returns Action<HTMLElement, any>
Composed action.
diff --git a/docs/functions/_standard_action_animate_ripple.ripple.html b/docs/functions/_standard_action_animate_composable_ripple.ripple.html similarity index 89% rename from docs/functions/_standard_action_animate_ripple.ripple.html rename to docs/functions/_standard_action_animate_composable_ripple.ripple.html index 5ebc8753..131da9ae 100644 --- a/docs/functions/_standard_action_animate_ripple.ripple.html +++ b/docs/functions/_standard_action_animate_composable_ripple.ripple.html @@ -1,5 +1,5 @@ripple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function ripple
- ripple(opts?): Action
Defines the classic Material Design ripple effect as an action.
rippleis a wrapper around the returned action. +Function ripple
- ripple(opts?): Action
Defines the classic Material Design ripple effect as an action.
rippleis a wrapper around the returned action. This allows it to be easily used as a prop.Note: A negative one translateZ transform is applied to the added spans allowing other content to be layered on top with a positive translateZ.
diff --git a/docs/functions/_standard_action_animate_ripple.rippleFocus.html b/docs/functions/_standard_action_animate_composable_ripple.rippleFocus.html similarity index 86% rename from docs/functions/_standard_action_animate_ripple.rippleFocus.html rename to docs/functions/_standard_action_animate_composable_ripple.rippleFocus.html index 81052698..e1045d0f 100644 --- a/docs/functions/_standard_action_animate_ripple.rippleFocus.html +++ b/docs/functions/_standard_action_animate_composable_ripple.rippleFocus.html @@ -1,5 +1,5 @@rippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Function rippleFocus
- ripple
Focus (opts?): Action Defines the classic Material Design ripple effect as an action that is attached to an elements focus and blur events. +
Function rippleFocus
- ripple
Focus (opts?): Action Defines the classic Material Design ripple effect as an action that is attached to an elements focus and blur events.
rippleFocusis a wrapper around the returned action. This allows it to be easily used as a prop.Note: A negative one translateZ transform is applied to the added spans allowing other content to be layered on top with a positive translateZ.
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index fd699cc6..ade0eac4 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,2 +1,2 @@TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -TyphonJS Runtime Library (FVTT) 0.2.0-next.1
Class Hierarchy
- SvelteComponent_1
- SvelteComponent
- ApplicationShell
- EmptyApplicationShell
- TJSApplicationShell
- TJSGlassPane
- TJSIconButton
- TJSSlotButton
- TJSToggleIconButton
- TJSColordButton
- TJSColordPicker
- TJSScrollContainer
- TJSFocusWrap
- TJSIconFolder
- TJSSvgFolder
- TJSButton
- TJSInput
- TJSInputCheckbox
- TJSInputNumber
- TJSInputText
- TJSSelect
- TJSContentEdit
- TJSProseMirror
- TJSTinyMCE
- TJSFileButton
- TJSFileIconButton
- TJSFileSlotButton
- TJSSettingsEdit
- TJSSettingsSwap
- TJSThemeEditor
- TJSSlotLabel
- TJSToggleLabel
- TJSPositionControlLayer
- TJSSideSlideLayer
- TJSMediaContent
- TJSMenu
- SvelteComponentTyped
- ApplicationShell
- SvelteComponent
TyphonJS Runtime Library (FVTT) 0.2.0-next.1
Class Hierarchy
- SvelteComponent_1
- SvelteComponent
- ApplicationShell
- EmptyApplicationShell
- TJSApplicationShell
- TJSGlassPane
- TJSIconButton
- TJSSlotButton
- TJSToggleIconButton
- TJSColordButton
- TJSColordPicker
- TJSScrollContainer
- TJSFocusWrap
- TJSIconFolder
- TJSSvgFolder
- TJSButton
- TJSInput
- TJSInputCheckbox
- TJSInputNumber
- TJSInputText
- TJSSelect
- TJSContentEdit
- TJSProseMirror
- TJSTinyMCE
- TJSFileButton
- TJSFileIconButton
- TJSFileSlotButton
- TJSSettingsEdit
- TJSSettingsSwap
- TJSThemeEditor
- TJSSlotLabel
- TJSToggleLabel
- TJSPositionControlLayer
- TJSSideSlideLayer
- TJSMediaContent
- TJSMenu
- SvelteComponentTyped
- ApplicationShell
- SvelteComponent
KeyBindingHandlerOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Interface KeyBindingHandlerOptions
+ -Interface KeyBindingHandlerOptions
Index
Properties
timeout? +Index
Properties
Properties
Optionaltimeouttimeout?: numberKeybinding sequences will wait this long between key presses before cancelling (default: 1000).
Note: Setting this value too low (i.e.
300) will be too fast for many diff --git a/docs/interfaces/_runtime_util_dom_tinykeys.KeyBindingMap.html b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html similarity index 94% rename from docs/interfaces/_runtime_util_dom_tinykeys.KeyBindingMap.html rename to docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html index 3b6b5edc..261eb3e7 100644 --- a/docs/interfaces/_runtime_util_dom_tinykeys.KeyBindingMap.html +++ b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html @@ -1,3 +1,3 @@KeyBindingMap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Interface KeyBindingMap
A map of keybinding strings to event handlers.
+Interface KeyBindingMap
A map of keybinding strings to event handlers.
Indexable
- (event): void
Parameters
- event: KeyboardEvent
Returns void
KeyBindingOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Interface KeyBindingOptions
Options to configure the behavior of keybindings.
++ +++
++ + Hierarchy
+++- KeyBindingHandlerOptions
- KeyBindingOptions (view full)
Properties
Optionalcapturecapture?: booleanKey presses will use a capture listener (default: false)
+Optionaleventevent?: "keydown" | "keyup"Key presses will listen to this event (default: "keydown").
+Optionaltimeouttimeout?: numberKeybinding sequences will wait this long between key presses before +cancelling (default: 1000).
+Note: Setting this value too low (i.e.
+300) will be too fast for many +of your users.KeyBindingOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Interface KeyBindingOptions
Options to configure the behavior of keybindings.
-- ---
-- - Hierarchy
---- KeyBindingHandlerOptions
- KeyBindingOptions (view full)
Properties
Optionalcapturecapture?: booleanKey presses will use a capture listener (default: false)
-Optionaleventevent?: "keydown" | "keyup"Key presses will listen to this event (default: "keydown").
-Optionaltimeouttimeout?: numberKeybinding sequences will wait this long between key presses before -cancelling (default: 1000).
-Note: Setting this value too low (i.e.
-300) will be too fast for many -of your users.StateMachineOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Interface StateMachineOptions
interface StateMachineOptions {
allowedTags?: Set<string>;
disallowedTags?: Set<string>;
encodePlaintextTagDelimiters: boolean;
tagReplacementText: string;
}Index
#standard/application/filepicker | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Package #standard/application/filepicker
+#runtime/svelte/action/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +\ No newline at end of file diff --git a/docs/modules/_standard_action_animate_ripple.html b/docs/modules/_runtime_svelte_store_dom_input.html similarity index 84% rename from docs/modules/_standard_action_animate_ripple.html rename to docs/modules/_runtime_svelte_store_dom_input.html index 3429f538..8a65b7ae 100644 --- a/docs/modules/_standard_action_animate_ripple.html +++ b/docs/modules/_runtime_svelte_store_dom_input.html @@ -1,12 +1,12 @@ -Package #runtime/svelte/action/dom/input
Index
-Classes
Type Aliases
#standard/action/animate/ripple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Package #standard/action/animate/ripple
+#runtime/svelte/store/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Package #runtime/svelte/store/dom/input
Index
-Functions
-Classes
ManagedPromise +Classes
Classes
Functions
#runtime/util/dom/tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Package #runtime/util/dom/tinykeys
A tiny (~650 B) & modern library for keybindings.
+#runtime/util/dom/input/tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Package #runtime/util/dom/input/tinykeys
A tiny (~650 B) & modern library for keybindings.
Super handy as
tinykeysreturns anunsubscribefunction which makes it easy to integrate with Svelte actions or otherwise.\ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_animate.html b/docs/modules/_runtime_util_html.html similarity index 69% rename from docs/modules/_runtime_svelte_action_animate.html rename to docs/modules/_runtime_util_html.html index ff020194..d232c545 100644 --- a/docs/modules/_runtime_svelte_action_animate.html +++ b/docs/modules/_runtime_util_html.html @@ -1,12 +1,11 @@ -See
https://www.npmjs.com/package/tinykeys
@@ -10,13 +10,13 @@#runtime/svelte/action/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Package #runtime/svelte/action/animate
+#runtime/util/html | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +\ No newline at end of file diff --git a/docs/modules/_standard_component_layer.html b/docs/modules/_runtime_util_html_striptags.html similarity index 60% rename from docs/modules/_standard_component_layer.html rename to docs/modules/_runtime_util_html_striptags.html index fc30e734..b1a530f6 100644 --- a/docs/modules/_standard_component_layer.html +++ b/docs/modules/_runtime_util_html_striptags.html @@ -1,14 +1,14 @@ -Package #runtime/util/html
Index
-Functions
#standard/component/layer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Package #standard/component/layer
+#runtime/util/html/striptags | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +\ No newline at end of file diff --git a/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html b/docs/modules/_standard_action_animate_composable.html similarity index 68% rename from docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html rename to docs/modules/_standard_action_animate_composable.html index cba31ce5..6f597ad8 100644 --- a/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html +++ b/docs/modules/_standard_action_animate_composable.html @@ -1,11 +1,12 @@ -Package #runtime/util/html/striptags
Index
-Classes
Namespaces
DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 -Namespace DOMPurify
+#standard/action/animate/composable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1 +Package #standard/action/animate/composable
Index
-Functions
sanitizeWith +Video Functions
- SvelteComponent_1
- ripple
- ripple
- opts: {
- sidebarData: FVTTSidebarRemoveData
- new FVTTSidebar
- new
- urls: string | {
- get
- get
- key: string
- handler: Subscriber<KeyStore>
- new
Provides a readable store to track keys actively pressed. KeyStore is designed to be used with the -keyforward action.
-