@theofficialurban/svelte-gradience
v1.0.5
Published
A very thin wrapper for beautiful gradient coloring made using `d3-interpolate`
Downloads
3
Readme
Svelte Gradience
A very thin wrapper for beautiful gradient coloring made using d3-interpolate
New Gradience Component
Props
element?
- div or spancolors
- An array of color pairs, [ [color1, color2], ... ]duration?
- Duration of the color loop , default1000
easing?
- An easing function, defaultlinear
interpolate?
- An interpolate function, see below for interpolate function type- The default interpolater being used is from
d3-interpolate
and it is theinterpolateRgbBasis()
function
- The default interpolater being used is from
type InterpolateFunction = (a: string, b: string) => (t: number) => string;
Example
<script lang='ts'>
import {Gradient} from '@theofficialurban/svelte-gradience'
</script>
<!-- Using Tailwind , Variable can be accessed -->
<!-- Color is automatically provided as variables -->
<!-- Pair #1 = --one | Pair #2 = --two etc -->
<Gradient class={`bg-[var(--one)]`} colors={[ ["red", "blue"] ]} let:colors>
Hello World!
</Gradient>
class Gradience
The Gradience Class allows you to create beautiful Gradients and interpolate colors easily
Color Return Methods
Gradience.asRawColors()
- Returns the colors as the RGB color string ('#FFFFFF')Gradience.asBackgroundColors()
- Returns the colors as CSSbackground-color
strings "background-color: color;"Gradience.asVariables()
- Returns the colors as a single CSS variable string "--one: colorOne; --two: colorTwo; ...."
Gradience.asRawColors()
Returns an array:
[
colorOne,
...
]
Gradience.asBackgroundColors
Returns an array:
[
"background-color: colorOne;",
"background-color: colorTwo;",
....
]
Gradience.asVariables
Returns an single string:
--one: colorOne; --two: colorTwo; ....
Example
<script lang="ts">
import Gradience from '@theofficialurban/svelte-gradience';
const myColors = [
// Pair #1, will interpolate between red and blue
['red', 'blue']
];
// Second Argument is Svelte Tweened Options /w Interpolater, leave blank for default
const gradience = new Gradience(myColors, { duration: 1000 });
const tweens = gradience.asRawColors();
const colorOne = $tweens[0]; // First tween corresponds to first set of colors
// If you want the colors as a `background-color: color;` string
const tweens = gradience.asBackgroundColors();
console.log($tweens[0]); // "background-color: colorOne;"
// As a single CSS variable string
const tweens = gradience.asVariables();
console.log($tweens); // '--one: colorOne; .....'
</script>
<!-- Using a single color -->
<!-- asBackgroundColors() -->
<div style={`${$tweens[0]} width: 200px; height: 200px`} />
<!-- Using asVariables() for a single string that declares variables -->
<div style={`${$tweens} width: 200px; height: 200px`} />