fab.width-awareness v1.2.1

Fabricator Width Awareness Component

While this component is designed with the BuzzingPixel Fabricator Build Process in mind, it can be used anywhere (in theory).

Installing

With Fabricator and NPM, simply require this library into your project and restart the Fabricator Grunt build process.

npm install fab.width-awareness --save

If you are not using Fabricator, you will need to in some manner compile src/FAB.widthAwareness.js into your build process or put it somewhere where you can link it into your projects.

Usage

FAB.widthAwareness.add();

Adds an element to width awareness watching.

add() argument 1

The first argument can be a jQuery selector string, a DOM object, or a jQuery object.

add() additional arguments

The second argument can be an array of sizes to add to the element, or all additional arguments after the first can be integer sizes to add for watching on the element.

FAB.widthAwareness.remove()

Remove elements from being watched by width awareness.

Takes one argument: a jQuery selector string, a DOM object, or a jQuery object.

FAB.widthAwareness.watchSelector();

Adds anything that matches the selector to width awareness watching, and watches the DOM for new selectors that match and adds them when they are added to the DOM.

Additional arguments work just like the add function where the second can be an array, or all additional arguments can be integers.

$('.myClass').trigger('widthAwarenessCheck')

Using the jquery trigger method, you can trigger a widthAwarenessCheck on your element to force it to update rather than waiting for a window resize event.

Styling

If you do not pass custom sizes, a default set is used (400, 500, 600, and on up through 1800). Regardless, as each width of the element is reached, the width is added to the data-widths attribute on the element. So you can use the space separator selector to look for it like so:

.myClass {
	background: red;
}
.myClass[data-widths~="400"] {
	background: blue;
}
.myClass[data-widths~="800"] {
	background: yellow;
}

Classes and Data Elements

Any element with the class .js-width-aware or the data attribute data-width-aware="true" already on the DOM or inserted onto the DOM will be made width aware and will receive the default set of width aware sizes.

License

Copyright 2017 TJ Draper, BuzzingPixel, LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.