Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cps-scss-framework

Package Overview
Dependencies
Maintainers
2
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cps-scss-framework

SCSS Framework to provide frequently used functions, mixins and styles.

  • 0.4.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
2
Created
Source

SCSS Framework

Frontend SCSS Framework to provide frequently used functions, mixins and styles.

Install

To use this framework you can simply download the project here on github, or install it with npm.

$ npm install cps-scss-framework

Usage

There are two ways of usage for this framework. The first option is to include the compiled dist/framework.css in your project. The second, more preferable, option is to include the src/framework.scss in your project and overwrite the default settings.

A) Include the pre-compiled css file

You can use the pre-compiled css file as standalone framework in your project. The Framework comes with some default options and styles, which cannot be overwritten in this method.

1.) Include the framework.css in your <head> section.

After you installed the framework as described in the Install section simply include the compiled .css file in your page <head> section.

<link rel="stylesheet" href="path/to/framwork/dist/framework.css">
2.) Use the included classes to style your website.

To learn more about all the included classes check out the Classes documentation.

B) Include the scss file and use your own settings

To overwrite some of the predefined styles you can include the framework in your SCSS setup.

1.) Create your own configuration file.

After you installed the framework as described in the Install section you should create your personal configuration file. Simply copy the src/_config.scss file to your scss path and change the configuration according to your needs.

Attention: Make sure to import your configuration file before the framework.scss!

2.) Import the framework.scss in your project.

After you created your personal configuration you need to include the framework.scss file in your projects main .scss file.

@import 'path/to/framework/src/framework.scss';

Attention: Make sure to import your configuration file before the framework.scss!

3.) Use the included functions, mixins and classes in your project.

Now you can use all the included functions, mixins and classes with your own configuration in your project. See the Functions, Mixins and Classes Documentation for further details.

Configuration

For all Configuration options see the Configuration documentation.

Included Functions, Mixins and Classes

The framework comes with many functions, mixins and classes, below you will find a short overview grouped by each module.

Global

Basic Functions and Mixins used by other modules.

License

Code released under the MIT License.

Keywords

FAQs

Package last updated on 05 Sep 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc