From e255ae5bac6fe1755473554af87e4b0318d86aaf Mon Sep 17 00:00:00 2001 From: Nystik <236107-Nystik@users.noreply.gitlab.com> Date: Wed, 15 Jan 2025 02:45:20 +0100 Subject: [PATCH] move docs back --- docs.js | 2 +- {core/docs => docs}/.nojekyll | 0 {core/docs => docs}/assets/hierarchy.js | 0 {core/docs => docs}/assets/highlight.css | 0 {core/docs => docs}/assets/icons.js | 0 {core/docs => docs}/assets/icons.svg | 0 {core/docs => docs}/assets/main.js | 0 {core/docs => docs}/assets/navigation.js | 0 {core/docs => docs}/assets/search.js | 0 {core/docs => docs}/assets/style.css | 0 {core/docs => docs}/index.html | 0 .../modules_dom_naie-dom.DOMUtils.html | 20 +++++++++---------- ...s_controls_naie-controls.NAIEControls.html | 4 ++-- ...s_controls_naie-controls.SelectOption.html | 4 ++-- ...ie-indicator-utils.NAIEIndicatorUtils.html | 4 ++-- ...e-indicator-utils.NAIEStatusIndicator.html | 4 ++-- ...nsions_loaders_naie-loader.NAIELoader.html | 6 +++--- ...nsions_naie-extensions.NAIEExtensions.html | 4 ++-- ...dules_internal_naie-internal.NAIECore.html | 6 +++--- ...s_internal_naie-internal.NAIEInternal.html | 12 +++++------ .../modules_logging_naie-logging.Logger.html | 4 ++-- ...ules_logging_naie-logging.NAIELogging.html | 12 +++++------ .../modules_misc_naie-misc.MiscEmitter.html | 8 ++++---- .../modules_misc_naie-misc.MiscUtils.html | 16 +++++++-------- ...dules_nai_modals_naie-modal.NAIEModal.html | 8 ++++---- ...i_modals_naie-modal.NAIEModalObserver.html | 8 ++++---- .../modules_nai_naie-nai.NAIUtils.html | 4 ++-- ...es_network_naie-network.BlockResponse.html | 4 ++-- ...ules_network_naie-network.NAIENetwork.html | 4 ++-- ...s_network_naie-network.NetworkManager.html | 14 ++++++------- ...ules_network_naie-network.RequestHook.html | 16 +++++++-------- ...les_network_naie-network.RequestUtils.html | 4 ++-- ...reflight_naie-preflight.NAIEPreflight.html | 4 ++-- ...eflight_naie-preflight.PreflightError.html | 4 ++-- ...reflight_naie-preflight.PreflightHook.html | 4 ++-- .../interfaces/naie-core.NAIE.html | 4 ++-- .../interfaces/naie-core.NAIEServices.html | 6 +++--- .../interfaces/naie-core.Window.html | 4 ++-- {core/docs => docs}/media/LICENSE | 0 {core/docs => docs}/modules.html | 0 .../modules/modules_dom_naie-dom.html | 0 ...les_extensions_controls_naie-controls.html | 0 ...nsions_indicator_naie-indicator-utils.html | 0 ...odules_extensions_loaders_naie-loader.html | 0 .../modules_extensions_naie-extensions.html | 0 .../modules_internal_naie-internal.html | 0 .../modules/modules_logging_naie-logging.html | 0 .../modules/modules_misc_naie-misc.html | 0 .../modules_nai_modals_naie-modal.html | 0 .../modules/modules_nai_naie-nai.html | 0 .../modules/modules_network_naie-network.html | 0 .../modules_preflight_naie-preflight.html | 0 {core/docs => docs}/modules/naie-core.html | 0 ...modules_logging_naie-logging.LogLevel.html | 2 +- ...odules_logging_naie-logging.LogMethod.html | 2 +- ...i_modals_naie-modal.ModalEventHandler.html | 2 +- ..._nai_modals_naie-modal.ModalPredicate.html | 2 +- ...eflight_naie-preflight.PreflightStage.html | 2 +- .../variables/naie-core.Window-1.html | 2 +- 59 files changed, 103 insertions(+), 103 deletions(-) rename {core/docs => docs}/.nojekyll (100%) rename {core/docs => docs}/assets/hierarchy.js (100%) rename {core/docs => docs}/assets/highlight.css (100%) rename {core/docs => docs}/assets/icons.js (100%) rename {core/docs => docs}/assets/icons.svg (100%) rename {core/docs => docs}/assets/main.js (100%) rename {core/docs => docs}/assets/navigation.js (100%) rename {core/docs => docs}/assets/search.js (100%) rename {core/docs => docs}/assets/style.css (100%) rename {core/docs => docs}/index.html (100%) rename {core/docs => docs}/interfaces/modules_dom_naie-dom.DOMUtils.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_controls_naie-controls.NAIEControls.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_controls_naie-controls.SelectOption.html (96%) rename {core/docs => docs}/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEIndicatorUtils.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_indicator_naie-indicator-utils.NAIEStatusIndicator.html (97%) rename {core/docs => docs}/interfaces/modules_extensions_loaders_naie-loader.NAIELoader.html (96%) rename {core/docs => docs}/interfaces/modules_extensions_naie-extensions.NAIEExtensions.html (96%) rename {core/docs => docs}/interfaces/modules_internal_naie-internal.NAIECore.html (97%) rename {core/docs => docs}/interfaces/modules_internal_naie-internal.NAIEInternal.html (95%) rename {core/docs => docs}/interfaces/modules_logging_naie-logging.Logger.html (95%) rename {core/docs => docs}/interfaces/modules_logging_naie-logging.NAIELogging.html (96%) rename {core/docs => docs}/interfaces/modules_misc_naie-misc.MiscEmitter.html (97%) rename {core/docs => docs}/interfaces/modules_misc_naie-misc.MiscUtils.html (96%) rename {core/docs => docs}/interfaces/modules_nai_modals_naie-modal.NAIEModal.html (96%) rename {core/docs => docs}/interfaces/modules_nai_modals_naie-modal.NAIEModalObserver.html (96%) rename {core/docs => docs}/interfaces/modules_nai_naie-nai.NAIUtils.html (97%) rename {core/docs => docs}/interfaces/modules_network_naie-network.BlockResponse.html (98%) rename {core/docs => docs}/interfaces/modules_network_naie-network.NAIENetwork.html (97%) rename {core/docs => docs}/interfaces/modules_network_naie-network.NetworkManager.html (96%) rename {core/docs => docs}/interfaces/modules_network_naie-network.RequestHook.html (95%) rename {core/docs => docs}/interfaces/modules_network_naie-network.RequestUtils.html (98%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.NAIEPreflight.html (98%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.PreflightError.html (95%) rename {core/docs => docs}/interfaces/modules_preflight_naie-preflight.PreflightHook.html (95%) rename {core/docs => docs}/interfaces/naie-core.NAIE.html (94%) rename {core/docs => docs}/interfaces/naie-core.NAIEServices.html (96%) rename {core/docs => docs}/interfaces/naie-core.Window.html (99%) rename {core/docs => docs}/media/LICENSE (100%) rename {core/docs => docs}/modules.html (100%) rename {core/docs => docs}/modules/modules_dom_naie-dom.html (100%) rename {core/docs => docs}/modules/modules_extensions_controls_naie-controls.html (100%) rename {core/docs => docs}/modules/modules_extensions_indicator_naie-indicator-utils.html (100%) rename {core/docs => docs}/modules/modules_extensions_loaders_naie-loader.html (100%) rename {core/docs => docs}/modules/modules_extensions_naie-extensions.html (100%) rename {core/docs => docs}/modules/modules_internal_naie-internal.html (100%) rename {core/docs => docs}/modules/modules_logging_naie-logging.html (100%) rename {core/docs => docs}/modules/modules_misc_naie-misc.html (100%) rename {core/docs => docs}/modules/modules_nai_modals_naie-modal.html (100%) rename {core/docs => docs}/modules/modules_nai_naie-nai.html (100%) rename {core/docs => docs}/modules/modules_network_naie-network.html (100%) rename {core/docs => docs}/modules/modules_preflight_naie-preflight.html (100%) rename {core/docs => docs}/modules/naie-core.html (100%) rename {core/docs => docs}/types/modules_logging_naie-logging.LogLevel.html (97%) rename {core/docs => docs}/types/modules_logging_naie-logging.LogMethod.html (98%) rename {core/docs => docs}/types/modules_nai_modals_naie-modal.ModalEventHandler.html (98%) rename {core/docs => docs}/types/modules_nai_modals_naie-modal.ModalPredicate.html (98%) rename {core/docs => docs}/types/modules_preflight_naie-preflight.PreflightStage.html (98%) rename {core/docs => docs}/variables/naie-core.Window-1.html (98%) diff --git a/docs.js b/docs.js index dffbf27..573e7c6 100644 --- a/docs.js +++ b/docs.js @@ -28,7 +28,7 @@ const getDtsFiles = (dir, files = []) => { const runTypedoc = (files) => { const version = getCoreVersion() const fileList = files.join(' ') - const command = `npx typedoc --out core/docs ${fileList} --name "NAIE Core API v${version}"` + const command = `npx typedoc --out docs ${fileList} --name "NAIE Core API v${version}"` console.log(`Running command: ${command}`) exec(command, (error, stdout, stderr) => { if (error) { diff --git a/core/docs/.nojekyll b/docs/.nojekyll similarity index 100% rename from core/docs/.nojekyll rename to docs/.nojekyll diff --git a/core/docs/assets/hierarchy.js b/docs/assets/hierarchy.js similarity index 100% rename from core/docs/assets/hierarchy.js rename to docs/assets/hierarchy.js diff --git a/core/docs/assets/highlight.css b/docs/assets/highlight.css similarity index 100% rename from core/docs/assets/highlight.css rename to docs/assets/highlight.css diff --git a/core/docs/assets/icons.js b/docs/assets/icons.js similarity index 100% rename from core/docs/assets/icons.js rename to docs/assets/icons.js diff --git a/core/docs/assets/icons.svg b/docs/assets/icons.svg similarity index 100% rename from core/docs/assets/icons.svg rename to docs/assets/icons.svg diff --git a/core/docs/assets/main.js b/docs/assets/main.js similarity index 100% rename from core/docs/assets/main.js rename to docs/assets/main.js diff --git a/core/docs/assets/navigation.js b/docs/assets/navigation.js similarity index 100% rename from core/docs/assets/navigation.js rename to docs/assets/navigation.js diff --git a/core/docs/assets/search.js b/docs/assets/search.js similarity index 100% rename from core/docs/assets/search.js rename to docs/assets/search.js diff --git a/core/docs/assets/style.css b/docs/assets/style.css similarity index 100% rename from core/docs/assets/style.css rename to docs/assets/style.css diff --git a/core/docs/index.html b/docs/index.html similarity index 100% rename from core/docs/index.html rename to docs/index.html diff --git a/core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html b/docs/interfaces/modules_dom_naie-dom.DOMUtils.html similarity index 97% rename from core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html rename to docs/interfaces/modules_dom_naie-dom.DOMUtils.html index 8d62ff5..d42f2f1 100644 --- a/core/docs/interfaces/modules_dom_naie-dom.DOMUtils.html +++ b/docs/interfaces/modules_dom_naie-dom.DOMUtils.html @@ -1,5 +1,5 @@
Creates a new HTML element with the specified tag and applies the given styles.
The tag name for the element (e.g., 'div', 'span').
Optional
styles: Record<string, string>An object containing CSS properties and values to apply to the element.
The newly created HTML element with applied styles.
-Finds elements with a mask image that includes all specified URL substrings.
+Finds elements with a mask image that includes all specified URL substrings.
An array of elements to search.
An array of substrings to check for in the mask-image property.
An array of elements that match the criteria.
-Adds a click event listener that triggers a callback when a click occurs outside the specified element. +
Adds a click event listener that triggers a callback when a click occurs outside the specified element.
Optionally, the listener can be removed after the first click if oneShot
is true.
The DOM element to detect clicks outside of.
The function to call when a click outside the element is detected.
Optional
oneShot: booleanOptional. If true, the listener is removed after the first click.
An object with a remove
method to manually remove the event listener.
Sets the value of an input element using native value setter methods.
+Sets the value of an input element using native value setter methods.
The input element to set the value for.
The value to set on the input element.
-Waits for an element to appear in the DOM.
The CSS selector of the element to wait for.
The maximum time to wait for the element in milliseconds.
Optional
rootElement: HTMLElementThe element to observe for mutations. Defaults to document.body.
A promise that resolves with the element if found, or null if not found within the timeout.
-
An interface defining general dom utility functions for NAIE
-