A Houdini Paint worklet for inverted corners using the CSS Paint API.
npm install inverted-corners🎨 A Houdini Paint worklet for inverted corners.
* Setup
* Standalone
* Worklet
* Check support
* Usage
* Properties
* Corners
* Backgrounds
* Basic gradient
* Tri-color gradient
* Color stops
* Angles
* Masks
* Images
* Examples
* Bugs & Features
* License
🧪 Please remember this is experimental and may not work in all browsers. Is Houdini ready yet?
Add the following to your HTML to include Inverted Corners using unpkg.
``html`
Omit the version number to use the latest version, or use a specific one:
`html`
That's it! Read the Usage section to learn how to access the paint worklet.
If you want to include the worklet yourself, you can add the paint module like this:
`javascript`
CSS.paintWorklet.addModule('https://unpkg.com/inverted-corners/lib/inverted-corners-worklet.min.js');
For example, in a React app you could execute this on the component mount:
`jsx
import React, { useEffect } from 'react';
const MyComponent = () => {
useEffect(() => {
if ('paintWorklet' in CSS) {
CSS.paintWorklet.addModule('https://unpkg.com/inverted-corners/lib/inverted-corners-worklet.min.js');
}
}, []);
return (
{/ some content here /}
);
};
export default MyComponent;
`
To check if a browser supports the Paint API via JavaScript:
`javascript`
if ('paintWorklet' in CSS) {
// Browser supports paint worklets, add the module here
} else {
console.warn('Houdini\'s Paint Worklet is not supported on your browser.');
}
To check if a browser supports the Paint API via CSS:
`css`
@supports (background: paint(something)) {
/ Browser supports paint worklets, do something here /
}
Once you're done with the Setup, you can immediately access the paint worklet with either background: paint(inverted-corners); or -webkit-mask-image: paint(inverted-corners);
There are three input properties for the paint worklet:
| Property | Description |
| --------------------- | ------------------------------------------------- |
| --corner-radius | The radii of the four corners |--background
| | A color or a gradient to use as the background |list-style-image
| | An image to use as the background |
You can set the radius of each corner using the --corner-radius property.
It uses a shorthand syntaxt similar to the native border-radius property.
`css`
--corner-radius:
For example,
`css`
--corner-radius: 20 20 -20 -20;
Positive values produce normal corners (similar to the border-radius property), while negative values produce inverted corners.
You can set the background using the --background property.
For example,
`css`
--background: #fff;
To add a shadow, use filter: drop-shadow()) instead of box-shadow.
You can also use gradients! Just set multiple colors separated with a comma.
#### Basic gradient
`
--background: cyan, purple;
#### Tri-color gradient
`
--background: #879af2, #d3206b, #fda000;
#### Color stops
To set a custom color stop, use the following format:
`
where is a number between 0.0 and 1.0.
For example,
`
--background: #879af2, #d3206b 0.2, #fda000;
#### Angles
To set a custom angle, add the rotation (in degrees) as the first parameter:
`
--background: 90deg, cyan, purple;
You can also use the mask-image (and the prefixed -webkit-mask-image) property to apply a mask and _reshape_ an element.
`css`
-webkit-mask-image: paint(inverted-corners);
mask-image: paint(inverted-corners);
When using masks, you can apply a background with the regular background, background-color, and background-image CSS properties.
Keep in mind, that while this method is really useful in some cases, you'll lose the ability to add shadows to the element.
To set an image as the background of the element, you can use the list-image-type property. This is necessary to workaround an issue where images wouldn't load with custom image properties on Chrome/Opera/Edge.
`css`
list-style-image: url(YOUR_IMAGE);
Take a look at the following examples:
* Browser tab
* Navbar menu
* Instant messaging
If you have spotted any bugs, or would like to request additional features from the library, please file an issue.
The MIT License, check the LICENSE` file.