Classname Utils

https://github.com/wongchisum/classname-utils
Admin
A lightweight and high-performance classname utility library that supports prefixes, separators, and...
Tokens:600
Snippets:6
Trust Score:6
Update:1 year ago
Show doc for...
Tokens:
Raw
### JavaScript Theme and Page Display Initialization

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/hierarchy.html

This JavaScript snippet handles the initial setup of the page's theme based on local storage or a default, and controls the display of the body element. It ensures the page is hidden until the application is ready or a timeout occurs, preventing a flash of unstyled content.

```JavaScript
document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";
document.body.style.display="none";
setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)
```

--------------------------------

### Initialize Theme and Page Display

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/functions/default.html

Initializes the theme based on local storage or OS preference and manages initial page display to prevent Flash of Unstyled Content (FOUC).

```JavaScript
document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";
document.body.style.display="none";
setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)
```

--------------------------------

### JavaScript Theme and Display Initialization Script

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/modules.html

This script configures the document's theme based on user preferences stored in local storage, defaulting to the operating system's theme. It temporarily hides the document body to prevent a flash of unstyled content (FOUC) and then reveals it after a short delay, ensuring the application has time to render.

```JavaScript
document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";
document.body.style.display="none";
setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)
```

--------------------------------

### API: config Method

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/functions/default.html

The config method allows configuring the utility. It takes a `UtilsConfig` object and returns a function that accepts unknown arguments and returns a string.

```APIDOC
Method: config
  config(config: UtilsConfig): (...args: unknown[]) => string
    Parameters:
      config: UtilsConfig
    Returns: (...args: unknown[]) => string
    Defined in: index.ts:119
```

--------------------------------

### APIDOC: classname-utils Functions Index

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/modules.html

This section provides an index of the functions available within the `classname-utils` library. It lists the primary functions that can be accessed and used, with a reference to their detailed documentation.

```APIDOC
Functions:
  - default
```

--------------------------------

### API: default Function

Source: https://github.com/wongchisum/classname-utils/blob/release/docs/functions/default.html

The default function of the classname-utils library. It accepts a variable number of unknown arguments and returns a string.

```APIDOC
Function: default
  default(...args: unknown[]): string
    Parameters:
      ...args: unknown[]
    Returns: string
    Defined in: index.ts:115
```
Tokens:
Raw