Skip to content
This repository was archived by the owner on Sep 25, 2020. It is now read-only.

Commit dd459c2

Browse files
committed
Add details about object-fit plugin to readme
1 parent ada6f38 commit dd459c2

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ yarn run build
2222

2323
Load up `./index.html` in your browser and you're off to the races!
2424

25+
## Object-Fit Utilities
26+
27+
In `plugins/object-fit/index.js` you'll find an example of a plugin that adds a set of simple, non-configurable utility classes for the `object-fit` property.
28+
29+
The only option it exposes are the variants you'd like to generate (`responsive`, `hover`, `focus`, etc.), which you pass to the plugin as a simple array:
30+
31+
```js
32+
plugins: {
33+
// ...
34+
require('./plugins/object-fit')(['responsive']),
35+
}
36+
```
37+
38+
This is just about the simplest type of plugin you could make.
39+
2540
## Simple Buttons
2641

2742
In `plugins/simple-buttons/index.js` you'll find an example of a plugin that adds new component classes.

0 commit comments

Comments
 (0)