emphasizer
React style emphasizer
Usage
Installation:
npm install emphasizer
LIVE DEMO
Methods
emphasizeStyle(...)
function emphasizeStyle(fromStyle: React.CSSProperties, toStyle: React.CSSProperties, rate: number): React.CSSProperties;
Parameters:
fromStyle
: style with lowest significancetoStyle
: style with highest significancerate
: rate of emphasized style. Must be fraction from 0
to 1
Returns: emphasized style
function emphasizeStyle(
fromStyle: React.CSSProperties,
toStyle: React.CSSProperties,
fromRate: number,
toRate: number,
rate: number,
): React.CSSProperties;
Parameters:
fromStyle
: style with lowest significancetoStyle
: style with highest significancefromRate
: min rate valuetoRate
: max rate valuerate
: rate of emphasized style. Must be value from fromRate
to toRate
Returns: emphasized style
Example
expect(
emphasizeStyle(
{
width: '8px',
margin: '2px 2px',
color: '#222222',
},
{
width: '12px',
margin: '6px 6px',
color: '#888888',
},
0.5,
),
).toMatchObject({
width: '10px',
margin: '4px 4px',
color: '#555555',
});
emphasizeStyleProperty(...)
function emphasizeStyleProperty(
fromValue: string | number,
toValue: string | number,
rate: number
): string | number | undefined;
Parameters:
fromValue
: style property value with lowest significancetoValue
: style property value with highest significancerate
: rate of emphasized style property. Must be fraction from 0
to 1
Returns: emphasized style property value
function emphasizeStyleProperty(
fromValue: string | number,
toValue: string | number,
fromRate: number,
toRate: number,
rate: number,
): string | number | undefined;
Parameters:
fromValue
: style property value with lowest significancetoValue
: style property value with highest significancefromRate
: min rate valuetoRate
: max rate valuerate
: rate of emphasized style property. Must be value from fromRate
to toRate
Returns: emphasized style property value
Example
emphasizeStyleProperty('8px', '12px', 0.5);
emphasizeStyleProperty('8px', '12px', 0, 2, 1);
emphasizeStyleProperty('8px 8px', '12px 12px', 0.5);
emphasizeStyleProperty('8px 8px 8px 8px', '12px 12px 12px 12px', 0.5);
emphasizeStyleProperty('#222222', '#444444', 0.5);
emphasizeStyleProperty('green', 'blue', 0.5);
emphasizeStyleProperty('rgb(0,0,0)', 'rgb(100,100,100)', 0.5);
emphasizeNumber(...)
function emphasizeNumber(fromValue: number, toValue: number, rate: number): number;
Parameters:
fromValue
: value with lowest significancetoValue
: value with highest significancerate
: rate of emphasized value. Must be fraction from 0
to 1
Returns: emphasized value
function emphasizeNumber(fromValue: number, toValue: number, fromRate: number, toRate: number, rate: number): number;
Parameters:
fromValue
: value with lowest significancetoValue
: value with highest significancefromRate
: min rate valuetoRate
: max rate valuerate
: rate of emphasized style property. Must be value from fromRate
to toRate
Returns: emphasized value
Example
emphasizeNumber(0, 10, 0.5);
emphasizeNumber(0, 10, 2, 4, 3);