Sneat Bootstrap 5 HTML Admin Template Documentation

The free version of Sneat includes the following components and pages:

• Layouts: Without menu, Without Navbar, Container, Fluid, and Blank.
• Pages: Account Settings, Login, Register, Forgot Password, Error, and Under Maintenance.
• UI Components: All Bootstrap components, Cards, and Tables.
• Form Elements: Basic Inputs and Input Groups (Vertical and Horizontal layouts).
• Extended UI: Perfect Scrollbar and Text Divider.
• Icons: Boxicons.
• Dashboard: 1 Simple Dashboard.
• Charts: 1 Chart Library.

The Sneat Bootstrap HTML Admin Template is licensed under the MIT license. While you can use it for personal and commercial purposes, ThemeSelection requires attribution. You must include the following link in the footer of your web application or project:

<a href="https://themeselection.com/">ThemeSelection</a>

Follow these steps to set up the development environment. Note that using Node, Webpack, and Gulp is optional; you can customize the template without them.

1. Install Node.js: Ensure you have the LTS version of Node.js installed.
2. Install Gulp CLI: Install the global Gulp command-line interface.
3. Install Dependencies: Navigate to the project root and install local dependencies using npm or yarn (Yarn is recommended).
4. Start Development Server: Run the serve task to start a local server with browsersync and enable code watching. The server will be available at http://localhost:3000/.

Support availability depends on your version:

• Free Version: Community support is available via GitHub issues.
• Premium Version: Dedicated support is provided by the expert team.

You can automate tasks by running predefined npm scripts from the Sneat root directory.

To run a task for a specific environment (e.g., development or production), use the --env={environment} option.

Tip: Use npm run without arguments to list all available predefined tasks in package.json.

Contributions are welcome via GitHub pull requests. To contribute:

1. Fork the repository.
2. Clone it to your local machine: git clone https://github.com/YOUR_USERNAME/REPO_URL.
3. Make your changes.
4. Create a pull request.

Contribution Requirements

• By contributing, you agree to grant a non-exclusive license to ThemeSelection to use your contribution.
• Any third-party content used must be appropriately licensed under an open source license.
• Contributed code must function correctly across all supported browsers.

The template uses a Menu class to manage the sidebar/layout menu. When the script runs, it automatically finds elements with the ID #layout-menu and instantiates a new Menu object. The menu instance is then attached to the global window.Helpers.mainMenu object for external access.

By default, the menu is initialized with a vertical orientation and closeChildren: false. You can also trigger a scroll to the active menu item using window.Helpers.scrollToActive(animate).

The window.Helpers object provides a suite of utility methods to control the template's core UI behaviors. Key methods initialized in main.js include:

• window.Helpers.toggleCollapsed(): Toggles the collapsed state of the layout menu.
• window.Helpers.setAutoUpdate(true): Enables automatic layout updates based on screen size changes.
• window.Helpers.initPasswordToggle(): Initializes the functionality for toggling password visibility in input fields.
• window.Helpers.initSpeechToText(): Initializes speech-to-text capabilities.
• window.Helpers.isSmallScreen(): Returns a boolean indicating if the current viewport is considered a small screen (mobile/tablet).