Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@bolt/components-sticky
Advanced tools
@bolt/components-sticky - npm Package Compare versions
Comparing version 0.10.0 to 1.0.0-rc.1
| { | ||
| "name": "@bolt/components-sticky", | ||
| "description": "Sticky Component in Bolt", | ||
| "type": "pattern", | ||
| "patternType": "molecules", | ||
| "keywords": [ | ||
@@ -13,3 +11,4 @@ "bolt design system", | ||
| ], | ||
| "version": "0.10.0", | ||
| "version": "1.0.0-rc.1", | ||
| "sourceFilesFrom": "0.10.0", | ||
| "maintainers": [ | ||
@@ -41,2 +40,3 @@ { | ||
| }, | ||
| "main": "src/sticky.js", | ||
| "style": "src/sticky.scss", | ||
@@ -47,9 +47,2 @@ "twig": "src/sticky.twig", | ||
| }, | ||
| "devDependencies": { | ||
| "@bolt/build-webpack": "^0.9.0" | ||
| }, | ||
| "scripts": { | ||
| "prepublishOnly": "npm run build", | ||
| "build": "./node_modules/@bolt/build-webpack/node_modules/.bin/webpack --env.production --env.cli --config ./node_modules/@bolt/build-webpack/webpack.config.cli.js --entry ./src/sticky --output-filename='bolt-sticky.min.js' --output-public-path /scripts/" | ||
| }, | ||
| "dependencies": { | ||
@@ -56,0 +49,0 @@ "stickybits": "^2.0.13" |
@@ -1,24 +0,3 @@ | ||
| # bolt/components-sticky | ||
| Sticky makes any component sticky to the top of the page. Part of the Bolt “Components” CSS framework that powers the [Bolt Design System](https://www.boltdesignsystem.com). | ||
| ## Demo | ||
| ``` | ||
| {% embed "@bolt/sticky.twig" %} | ||
| {% block sticky_content %} | ||
| <div style="background-color: white"> | ||
| Sticky content goes here | ||
| </div> | ||
| {% endblock %} | ||
| {% endembed %} | ||
| ``` | ||
| - - - - | ||
| ## Table of Contents | ||
| - [Cheat Sheet](#cheat-sheet) | ||
| - [Getting Started](#getting-started) | ||
| - [Further Reading](#further-reading) | ||
| ## Cheat Sheet | ||
| ### Install via NPM | ||
@@ -28,43 +7,1 @@ ``` | ||
| ``` | ||
| - - - - | ||
| ## Getting Started | ||
| The best way to start using Bolt is via the *Bolt Starterkit* (coming soon), a pre-assembled front-end boilerplate designed to get you up and running as quickly as possible. | ||
| You can also use the full [Bolt Core](https://www.npmjs.com/package/@bolt/core) CSS framework on its own, or, install just the parts you need and fold the different ITCSS layers of Bolt into your existing codebase. | ||
| Installing Bolt’s Sticky component is as easy as running NPM install: | ||
| ``` | ||
| npm install @bolt/components-sticky | ||
| ``` | ||
| > **TIP:**: Don’t have a `package.json` file? Need a little help getting started? Check out our [Getting Started](https://www.boltdesignsystem.com/getting-started) guide for some tips to help get you up to speed. | ||
| ### Usage | ||
| Once installed, you should `@import` the main Sass partial into your project’s main `.scss` file to make the included variables available to the rest of your code. | ||
| ``` | ||
| // Settings | ||
| ... | ||
| // Tools | ||
| ... | ||
| ``` | ||
| Since Bolt’s CSS architecture is based on [ITCSS (Inverted Triangle CSS)](http://www.creativebloq.com/web-design/manage-large-css-projects-itcss-101517528)<sup>[1](#1-learn-more-about-itcss)</sup>, what Sass partials you import, and in what order, makes a whole world of difference. That’s why importing any Settings packages from Bolt in your project’s Settings layer (prior to any Sass mixins, resets, base HTML element styles, etc) is so important. | ||
| ### Compiling | ||
| We recommend using Bolt’s Gulp-based [front-end build tools](https://www.npmjs.com/package/@bolt/build-tools) to compile your Sass as we’re pre-packaging many of the latest tools and add-ons to help you write your very best: LibSass, Autoprefixer, PostCSS, CleanCSS, Sassdoc, Stylelint, Gulp Plumber, npm-sass, and BrowserSync live reloading. | ||
| - - - - | ||
| ## Further Reading: | ||
| <h3 id="learn-about-itcss">1. Learn more about ITCSS</h3> | ||
| - [Harry Roberts - Managing CSS Projects with ITCSS - YouTube](https://www.youtube.com/watch?v=1OKZOV-iLj4) | ||
| - [ITCSS: Scalable and Maintainable CSS Architecture - Xfive](https://www.xfive.co/blog/itcss-scalable-maintainable-css-architecture/) | ||
| - [Manage large CSS projects with ITCSS | Creative Bloq](http://www.creativebloq.com/web-design/manage-large-css-projects-itcss-101517528) | ||
| - [How I Shrank my CSS by 84kb by Refactoring with ITCSS](https://medium.com/@jordankoschei/how-i-shrank-my-css-by-84kb-by-refactoring-with-itcss-2e8dafee123a) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Trivial Package
Supply chain riskPackages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Trivial Package
Supply chain riskPackages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.
Found 1 instance in 1 package
Improved metrics
- Dev dependency count
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-97.49%
2194
- Number of package files
- decreased by-45.45%
6
- Lines of code
- decreased by-71.43%
2
- Number of lines in readme file
- decreased by-90%
7
No dependency changes