An open API service indexing awesome lists of open source software.

https://github.com/nulllogic/scssleon

ΰΌ» 🦎 SCSSLEON framework ΰΌΊ ≧◑≦
https://github.com/nulllogic/scssleon

css css-framework frontend scss scss-framework scssleon ui ux

Last synced: 2 months ago
JSON representation

ΰΌ» 🦎 SCSSLEON framework ΰΌΊ ≧◑≦

Awesome Lists containing this project

README

          




SCSSleon framework

# SCSSLEON [![Version Number](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnulllogic%2Fscssleon%2Frefs%2Fheads%2Fmaster%2Fpackage.json&query=%24.version&style=flat&label=version&labelColor=%23b0de48&color=%231b3317)](https://github.com/Tencent/QMUI_Web/ "Version Number")

Welcome to SCSSLEON framework ! It's the most advanced responsive front-end framework, that can boost development of your website or project. It was built in love and with love from internet technologies. Peace !



– [ Documentation ] β€” [ Bugs/Issues ] β€” [ StackOverflow ] –


## Table of Contents

β†ͺ β‰‘Λš ✧ β”β”β”β”βŠ±TOCβŠ°β”β”β”β” ✧ β‚ŠΛšβ‰‘

- [Why SCSSLEON?](#user-content---why-scssleon--)
- [Features](#user-content---features-)
- [Getting started](#user-content---getting-started-)
- [Usage Examples](#user-content---usage-examples-)
- [Showcase](#user-content---showcase-)
- [Documentation](#user-content---documentation-)
- [Contributing](#user-content--contributing-)
- [Thanks](#user-content--thanks-)
- [License](#user-content---license-)


### β“˜ Prerequisites
- Knowledge of [SCSS](https://sass-lang.com).
- [🐳 Docker](https://www.docker.com)
- [πŸ’» Node](https://nodejs.org) + [πŸ“¦ NPM](https://nodejs.org)


## β”Œ πŸ€” Why SCSSLEON ? ┐

SCSSLEON is designed for developers who want a lightweight, modular, and highly customizable SCSS framework. Unlike other frameworks, SCSSLEON:

- Offers a minimal footprint for faster load times.
- Provides intuitive mixins and utilities for rapid development.
- Supports easy theming with customizable variables.
- Color scheme support – easily add dark and light theme support
- Responsive support with zero efforts
- Easy to learn, easy to use
- Zero dependencies, except SASS

(back to top)


## β”Œ ✨ Features ┐

- **Responsive Grid System**: Build flexible layouts with a customizable 12-column grid.
- **Theming Support**: Easily customize colors, fonts, and spacing with SCSS variables.
- **Utility Classes**: Includes helpers for spacing, typography, and visibility.
- **Lightweight**: Minimal CSS output for faster performance.
- **Modern CSS**: Built-in support for Flexbox, CSS Grid, and custom properties.

(back to top)


## β”Œ 🧭 Getting Started ┐

Method #1 - NodeJS + NPM basic setup [ πŸ›–πŸ”₯🦴 primitive ]

1. Install packages – run the following command in your project directory to install SCSSLEON + SASS:

```bash
npm i @nulllogic/scssleon sass
```

2. Initialize your project (if not already done). If your project doesn't have a package.json file, create one by running:

```bash
npm init -y
```

3. Update `package.json` file. Add following strings

```json
"scripts": {
"sass-dev": "sass --watch --update --style=expanded styles:assets/css --load-path=node_modules",
"sass-prod": "sass --no-source-map --style=compressed styles:assets/css --load-path=node_modules"
}
```

It will look like this :
```json
{
"dependencies": {
"@nulllogic/scssleon": "^1.0.5",
"sass": "^1.89.2"
},
"name": "test",
"version": "1.0.0",
"main": "index.js",
"devDependencies": {},
"scripts": {
"sass-dev": "sass --watch --update --style=expanded styles:assets/css --load-path=node_modules",
"sass-prod": "sass --no-source-map --style=compressed styles:assets/css --load-path=node_modules"
},
"keywords": [],
"author": "",
"license": "ISC",
"description": ""
}
```

4. Create `app.scss` inside your project in `/styles` directory

```scss
@use 'sass:map';
@use "sass:string";

@forward "@nulllogic/scssleon/scss/mixins";
@forward "@nulllogic/scssleon/scss/functions";

@use "@nulllogic/scssleon/scss/config.scss" as config with (
// This is main config, that you can tweak
$config: (
prefix: "xii",
enable: (
wrapper: false,
),
)
);

@use "@nulllogic/scssleon/themes/default.scss" as theme with (
$config : config.$config,
$theme: (
html : (
body : (
_colors: (
light : (
background : rgb(244, 244, 244),
color: rgb(28, 29, 31),
),
dark : (
background : rgb(5, 17, 4),
color: '#ccc'
)
)
)
)
)
);

$config: config.$config;
$theme: theme.$theme;
```

5. Create `base.scss` inside your project in `/styles/components` directory
```scss
// Loading your SCSS module with pre-defined config and theme
// ↓ Config
@use "../app.scss" as app;

// Loading modules and components
// ↓ Root
@use "@nulllogic/scssleon/scss/root" with (
$config: app.$config,
$theme: app.$theme
);

// Great reset
@use "@nulllogic/scssleon/scss/reset" with (
$config: app.$config,
$theme: app.$theme
);

// Base
@use "@nulllogic/scssleon/scss/base" with (
$config: app.$config,
$theme: app.$theme
);
```

6. Run node command at root `/` of your project to generate CSS code to `/assets/css`

```bash
npm run sass-dev
```

7. Profit – you have output at `/assets/css` directory now πŸ™Œ

SCSSleon framework

(back to top)


## β”Œ πŸ‘“ Usage Examples ┐

(back to top)


## β”Œ πŸ“Ί Showcase ┐




SCSSleon framework


2


1
2

(back to top)


## β”Œ πŸ“š Documentation ┐

SCSSLeon documentation is available here [http://nulllogic.github.io/scssleon-docs](http://nulllogic.github.io/scssleon-docs)

Documentation is built with [Astro](https://astro.build/) and publicly hosted on GitHub Pages [here](http://nulllogic.github.io/scssleon-docs).
Search is powered by [Algolia](https://community.algolia.com/docsearch/).

(back to top)


## β”Œ Contributing ┐

For contributing, please view the [CONTRIBUTING](CONTRIBUTING.md).

(back to top)


## β”Œ Thanks ┐




SCSSleon framework


Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers!

(back to top)


## β”Œ πŸ“œ License ┐
[MIT license](LICENSE)






SCSSleon framework