Members
(constant) ProgressBar
- Description:
Functional component version for direct use in JSX Example:
- Source:
Functional component version for direct use in JSX Example:
(constant) fullTrim
- Description:
Trims whitespace from a multi-line string while preserving relative indentation
- Source:
Trims whitespace from a multi-line string while preserving relative indentation
(constant) wikishieldStyling
- Description:
WikiShield styling object containing CSS for different parts of the application Each property contains CSS as a string that can be injected into style tags
- Source:
WikiShield styling object containing CSS for different parts of the application Each property contains CSS as a string that can be injected into style tags
Methods
hasApproxSubstring()
- Description:
WikiShieldUtil - Utility helper functions Collection of helper methods for string manipulation, formatting, and conversions
- Source:
injectNamedStyles(…styleNames) → {HTMLStyleElement}
- Description:
Helper function to inject multiple named styles
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
styleNames |
string |
<repeatable> |
Names of styles to inject |
Returns:
The created style element
- Type
- HTMLStyleElement
injectStyles(css, id) → {HTMLStyleElement}
- Description:
Helper function to inject styles into the document
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
css |
string | CSS string to inject |
id |
string | Optional ID for the style tag |
Returns:
The created style element
- Type
- HTMLStyleElement
loadStyles(…styleNames) → {string}
- Description:
Helper function to load multiple styles at once
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
styleNames |
string |
<repeatable> |
Names of styles to load (e.g., 'base', 'main') |
Returns:
Combined CSS string
- Type
- string
useProgressBar()
- Description:
React Hook for using progress bars in functional components Example usage:
const MyComponent = () => { const [progress, setProgress] = useProgressBar();
const doWork = async () => { setProgress('Working...', 0.5, 'blue'); await someAsyncWork(); setProgress('Done!', 1.0, 'green'); };
return ; };
- Source: