Noun/Pronoun Mix-up

    jigsass-objects-card

    2.0.1 • Public • Published

    JigSass Objects Card

    NPM version Dependency Status

    An individual piece of distinguished UI

    Installation

    Using npm:

    npm i -S jigsass-objects-card

    Usage

    First, you need to import JigSass Card:

    @import 'path/to/jigsass-objects-card/scss/index';

    And optionally reconfigure the defaults to your liking.

    Like all other JigSass modules, JigSass Card does not automatically generate any CSS when imported. In order to use its classes, you would have to first explicitly indicate your intention to use them by enabling their generation in the associated configurations map, Leaving us only with CSS we need:

    All JigSass Card classes are responsive-enabled, using JigSass MQ and the breakpoints defined in the $jigsass-breakpoints variable.

    Based on enabled selectors in the configuration map, responsive modifiers are generated according to the following logic:

    .o-card[--modifier][-[-from-{breakpoint-name}][-until-{breakpoint-name}][-misc-{breakpoint-name}]]

    So, assuming the medium, large and landscape breakpoints are defined in $jigsass-breakpoints as 600px, 1024px and (orientation: landscape) respectively,

    $jigsass-card-conf: (
      no-breakpoint: (
        raised: true,
      ),
      until-medium: (
        raised: true,
      ),
      from-large-when-landscape: (
        raised: true,
      ),
    )

    will generate the following classes:

    • .o-card--raised, which is not limited to any media-query.
    • .o-card--raised--until-medium, which will be in effect at (max-width: 37.49em) and will override styles in the default class until that point.
    • .o-card--raised--from-large-when-landscape, which will go into effect at (min-width: 64em) and (orientation: landscape) and will override styles in the default class under these conditions.

    Documentation

    The full documentation was generated using mdcss, and is available at https://txhawks.github.io/jigsass-objects-card/

    Contributing

    It is a best practice for JigSass modules to not automatically generate css on @import, but rather have the user explicitly enable the generation of specific styles from the module.

    Contributions in the form of pull-requests, issues, bug reports, etc. are welcome. Please feel free to fork, hack or modify JigSass Card in any way you see fit.

    Writing documentation

    Good documentation is crucial for usability, scalability and maintainability. When contributing, please do make sure that both its Sass functionality (functions, mixins, variables and placeholder selectors), as well as the CSS it generates (selectors, concepts, usage exmples, etc.) are well documented.

    Jigsass Card uses Jonathan Neal's mdcss.

    When styles and documentation comments are not automatically generated by your module on @import, please use the sgSrc/sg.scss file to enable their generation.

    In addition, any file in sgSrc/assets will be available for use in the style guide.

    File structure

    ┬ ./
    ├─┬ scss/ 
    │ └─ index.scss # The module's importable file. 
    ├─┬ sgSrc/      # Style guide sources 
    │ │
    │ ├── sg.sccs   # It is a best practice for JigSass  
    │ │             # modules to not automatically generate  
    │ │             # css and documentation on `@import.`  
    │ │             # Please use this file to enable css 
    │ │             # and documentation comments) generation. 
    │ │
    │ └── assets/   # Files in `sgSrc/assets` will be  
    │               # available for use in the style guide 
    └─┬ docs/      # Documention 
      │
      └── styleguide/ # Generated documentation  
                      # of the module's CSS 

    License: MIT

    Install

    npm i jigsass-objects-card

    DownloadsWeekly Downloads

    0

    Version

    2.0.1

    License

    MIT

    Last publish

    Collaborators

    • txhawks