lcs_dystyle
v1.2.1
Published
LCS dySTYLE: A powerful JavaScript library for dynamic, class-based CSS styling. Apply responsive, complex, and custom styles directly through HTML class names, eliminating the need for external CSS files.
Readme
LCS dySTYLE
LCS dySTYLE is a dynamic, JavaScript-based CSS management library. It enables developers to apply complex, responsive, and custom styles directly through HTML class names, eliminating the need for static CSS files. This lightweight and flexible library supports pseudo-elements, sibling and child selectors, media queries, and direct style properties — all using class names.
Features
- Dynamic Styling: Apply CSS styles dynamically with a structured class name syntax, reducing the need for external CSS files.
- Multi Styling: Combine multiple CSS properties and values in a single class name for concise styling.
- Shortcut Patterns: Use shortened syntax for common properties to streamline styling.
- Responsive Support: Embed media queries in class names for responsive designs.
- Advanced Selectors: Style sibling, child, and type-based elements directly through class names.
- Pseudo-Classes and Pseudo-Elements: Use
:hover,:focus,::before, and::afterstyles effortlessly. - Customizable Control: Use
data-dystyle="false"to exclude specific elements or the entire body fromdySTYLEprocessing.
Installation
You can install LCS dySTYLE via npm:
npm install lcs_dystyleOr clone the repository from GitHub:
git clone https://github.com/lcsnigeria/lcs_dystyle.gitThen, include the script in your HTML:
<script src="https://cdn.jsdelivr.net/npm/lcs_dystyle/dist/ld.min.js"></script>Usage
Add the lcs prefix to your class names to dynamically apply styles. LCS dySTYLE interprets the class names as CSS rules, allowing direct styling through naming conventions.
Example
<!-- Basic style application -->
<div class="lcsBackgroundColor_red"></div>
<!-- Multi style application -->
<div class="lcsBackgroundColor.PaddingTop_red.20px">Multi Styling Example</div>
<!-- Shortcut pattern -->
<div class="lcsBGC_lightblue">Light Blue Background using Shortcut</div>
<!-- Responsive styling -->
<div class="lcsMQMaxWidth600PX_FontSize_14px">Responsive Font Size</div>
<!-- Pseudo-element styling (COMING SOON) -->
<div class="lcsBefore_BackgroundColor_red">Pseudo-element Example</div>
<!-- Advanced selectors (COMING SOON) -->
<ul>
<li class="lcsSibling_BackgroundColor_lightblue">List Item with Sibling Styling</li>
</ul>Disabling dySTYLE on Specific Elements
To disable dySTYLE on specific elements or the entire body, use the data-dystyle="false" attribute:
<!-- Disables dySTYLE on this div -->
<div data-dystyle="false" class="lcsBackgroundColor_red">This will not be styled by dySTYLE.</div>
<!-- Disables dySTYLE on the entire body -->
<body data-dystyle="false">
<!-- All elements inside the body will not be styled by dySTYLE -->
</body>Class Name Structure
Class names are parsed by LCS dySTYLE and converted to CSS rules. Use the following structure to construct class names:
lcs[MediaQuery]_[SpecificSelector]_[PseudoClass]_[CSSProperty]_[CSSValue]Class Name Syntax Details
- Media Queries: Prefix classes with
lcsMQfor responsive styling. - Multi Styling: Define multiple properties and values in a single class name (e.g.,
lcsBackgroundColor.PaddingTop_red.20px). - Shortcut Patterns: Use shorthand syntax for frequently used properties, like
lcsBGC_lightblueforbackground-color: lightblue. - Advanced Selectors: Use
lcsAllOfType,lcsSibling(COMING SOON),lcsChild(COMING SOON), and similar selectors to apply styles to child or sibling elements. - Pseudo-Classes and Pseudo-Elements: Use
lcsHPE(COMING SOON) for:hover,lcsBPE(COMING SOON) for::before, and other similar syntax. - Direct Properties: Apply specific styles using the format
lcs[Property]_[Value].
Example Syntax
<!-- Direct property example -->
<div class="lcsBackgroundColor_red">Red Background</div>
<!-- Multi Styling example -->
<div class="lcsBackgroundColor.Color.Padding_lightblue.white.10px">Multi Styled Element</div>
<!-- Shortcut example -->
<div class="lcsBGC_lightblue">Light Blue Background</div>
<!-- Media query example -->
<div class="lcsMQMaxWidth768PX_FontSize_12px">Font size 12px on screens 768px wide or smaller</div>Internal Workings
LCS dySTYLE operates only on elements within the body tag and dynamically generates and injects CSS rules into the document’s internal style element. The library skips elements with data-dystyle="false" attributes, enabling selective styling control.
Manual Initialization
In addition to automatically applying styles when the DOM content is loaded, LCS dySTYLE provides the lcsRunDyStyle function for users who want more control over when the dySTYLE processing starts. This allows developers to delay or manually trigger the processing of styles to suit specific application needs.
Purpose
By default, LCS dySTYLE processes all elements with matching class names as soon as the DOM content is fully loaded. However, if you want to defer this process or apply styles dynamically after certain events (e.g., loading additional content via AJAX), you can call the lcsRunDyStyle function manually.
Example
// Delayed initialization
document.addEventListener("DOMContentLoaded", function () {
// Perform custom operations before initializing dySTYLE
lcsRunDyStyle(); // Manually initialize dySTYLE processing
});
// Example of using after dynamically adding content
function addContentAndStyle() {
const newDiv = document.createElement('div');
newDiv.className = 'lcsBackgroundColor_red';
document.body.appendChild(newDiv);
// Manually re-run dySTYLE to process new content
lcsRunDyStyle();
}Use Cases
- Lazy Loading: Apply styles only after certain elements are loaded or added to the DOM.
- Dynamic Content: Process styles for elements added dynamically via JavaScript or AJAX.
- Selective Initialization: Defer initialization until specific application events occur.
Disabling Automatic Initialization
To fully control when lcsRunDyStyle is called, you can disable the automatic initialization by removing the DOMContentLoaded listener in the library's source code or simply allowing it to execute as-is without affecting manual calls.
Development
For contributing, clone the repository and open a pull request with your updates. Contributions, issue reporting, and feature requests are welcome.
License
This project is licensed under the MIT License. See the LICENSE file for details.