npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dmsi/wedgekit

v9.2.0

Published

Web UI pattern library for DMSi Software

Downloads

42

Readme

Getting Started

Wedgekit is meant as a starter guide and kit to quickly begin a DMSi project or help apply consistency in your project.

Methodology

Wedgekit follows BEM methodology for naming classnames and the Atomic Design methodology for sorting and organizing components.

BEM (Block, Element, Modifier)

The Block, Element, Modifier methodology (commonly referred to as BEM) is a popular naming convention for classes in HTML and CSS. Developed by the team at Yandex, its goal is to help developers better understand the relationship between the HTML and CSS in a given project.

Good documentation on this

Atomic design

Atomic design is way to structure and organize your stylesheets in a way that makes sense to you and your team. Read this - http://atomicdesign.bradfrost.com/chapter-2/ to learn more about the methodology.

Importing WedgeKit

You may either import wedgekit.scss or the individual components. NOTE the order of this is very important.

@import "settings/settings"; // required
@import "mixins/mixins"; // required
@import "tools/tools"; // required
@import "atoms/atoms";
@import "molecules/molecules";
@import "organisms/organisms";
@import "utilities/utilities";

Adding new SCSS components

This is a working style guide. Add new components and documentation as needed for DMSi project. Make sure to follow the atomic design approach to decide where to place the new component.

Let's say you want to add a new organism. Simply add _.myNew.organisms.scss to the /scss/organisms directory. To import your new component, add @import "myNew.organisms"; to /scss/organisms/_organisms.scss file.

Adding new JS components

To add a new JS component, use the command:

yarn run add-component

Enter the name of the component, and indicate whether it can be created as a stateless function. For more information about stateless functions, see here.

Library Use

yarn add @dmsi/wedgekit

OR

npm install --save @dmsi/wedgekit

######Importing

import { Alerts } from '@dmsi/wedgekit'

######Webpack

//webpack.config.js

module.exports = {
  entry: [
    '!!style-loader!css-loader!../node_modules/@dmsi/wedgekit/wedgekit.css'
  ]
};

Grid

In addition to @dmsi/wedgekit, this repository also contains the code for a grid component published to npm as @dmsi/grid. This component contains a lot of functionality from various grid & data processing libraries, so it's published as a separate module.

yarn add @dmsi/grid

OR

npm install --save @dmsi/grid

Releasing

To create a new release of Wedgekit or the Grid, first make sure all changes are merged into develop. Then make a release branch off of develop, titled release/SEMVER_LEVEL. The semver level should be 'patch', 'minor', or 'major', following semver rules. Generally, a fix to an existing component would be a patch, a new component would be a minor release, and breaking changes would be a major release.

It is important to follow the pattern of release/patch, release/minor, or release/major because the automated release publishing is looking for that pattern.

Once the release branch is created with the correct name, merge the release branch into master. This can be achieved by creating a pull request in Bitbucket. Once it is merged, CircleCI will handle bumping the version, tagging it, and publishing it in npm.

Once the build has finished on master, pull the master branch into develop to make sure all development work has the correct version going forward.

TODO

  • Reminder: add DMSi rules for when/how to use a component.
  • Document settings, tools, mixins and utilities.