From 4fb6a5d5fbd006d04d399938a257b958d169069e Mon Sep 17 00:00:00 2001 From: heyjul3s Date: Tue, 12 Jan 2021 13:18:52 +1100 Subject: [PATCH 1/3] fluidSizing fix - fix units for fluidSizing pkg - update fluidSizing docs --- docs/containers/FluidSizing/FluidSizing.tsx | 6 ++++-- .../FluidSizing/examples/fluidSizing.ts | 4 ++-- packages/fluidsizing/README.md | 19 ++++++++++--------- packages/fluidsizing/src/fluidSizing.ts | 11 ++++++++--- 4 files changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/containers/FluidSizing/FluidSizing.tsx b/docs/containers/FluidSizing/FluidSizing.tsx index 5d74ced..34d9832 100644 --- a/docs/containers/FluidSizing/FluidSizing.tsx +++ b/docs/containers/FluidSizing/FluidSizing.tsx @@ -19,7 +19,6 @@ export function FluidSizingContent() { A fluid sizing utility function that creates a calc value based off of the min and max values provided.{' '} - Values are evaluated in "px".
@@ -30,9 +29,11 @@ export function FluidSizingContent() { minElementSize: 'number', maxElementSize: 'number', minViewportWidth: 'number', - maxViewportWidth: 'number' + maxViewportWidth: 'number', + unit: 'string' }} /> + This function writes a CSS rule that allows for fluid sizing. Essentially, this eliminates the need for media queries as the element @@ -41,6 +42,7 @@ export function FluidSizingContent() { and also the minimum and maximum size of the viewport width that you intend to use as constraints. Below is an example of how you may use it. + {fluidSizingExampleUsage}
diff --git a/docs/containers/FluidSizing/examples/fluidSizing.ts b/docs/containers/FluidSizing/examples/fluidSizing.ts index 809695b..7d7df4e 100644 --- a/docs/containers/FluidSizing/examples/fluidSizing.ts +++ b/docs/containers/FluidSizing/examples/fluidSizing.ts @@ -4,7 +4,7 @@ export const fluidSizingExampleUsage = ` export const LargeLeadText = styled.p\` color: hotpink; - font-size: \${fluidSizing(20, 48, 300, 1200)}; - padding-bottom: \${fluidSizing(10, 15, 300, 1200)} + font-size: \${fluidSizing(1.3, 1.5, 300, 1200, 'rem')}; + padding-bottom: \${fluidSizing(10, 15, 300, 1200, 'px')} \`; `; diff --git a/packages/fluidsizing/README.md b/packages/fluidsizing/README.md index 2018f75..ba051e6 100644 --- a/packages/fluidsizing/README.md +++ b/packages/fluidsizing/README.md @@ -20,20 +20,21 @@ npm install @artifak/fluidsizing Below are the parameters and the following an example of usage. -| Arguments | Type | -| ---------------- | ------ | -| minElementSize | number | -| maxElementSize | number | -| minViewportWidth | number | -| maxViewportWidth | number | +| Arguments | Type | +| ---------------- | --------------------- | +| minElementSize | number | +| maxElementSize | number | +| minViewportWidth | number | +| maxViewportWidth | number | +| unit | 'em' \| 'px' \| 'rem' | ```ts import { fluidSizing } from '@artifak/fluidsizing'; import styled from 'styled-components'; const Paragraph = styled.p` - font-size: ${fluidSizing(16, 96, 300, 1200)}; - line-height: ${fluidSizing(1.4, 1.6, 300, 1200)}; - padding-bottom: ${fluidSizing(10, 15, 300, 1200)}; + font-size: ${fluidSizing(16, 96, 300, 1200, 'px')}; + line-height: ${fluidSizing(1.4, 1.6, 300, 1200, 'rem')}; + padding-bottom: ${fluidSizing(10, 15, 300, 1200, 'px')}; `; ``` diff --git a/packages/fluidsizing/src/fluidSizing.ts b/packages/fluidsizing/src/fluidSizing.ts index 34615b1..de11e7f 100644 --- a/packages/fluidsizing/src/fluidSizing.ts +++ b/packages/fluidsizing/src/fluidSizing.ts @@ -2,12 +2,17 @@ export function fluidSizing( minElementSize: number, maxElementSize: number, minViewportWidth: number, - maxViewportWidth: number + maxViewportWidth: number, + unit: 'em' | 'px' | 'rem' ): string { return !!minElementSize && !!maxElementSize && !!minViewportWidth && - !!maxViewportWidth - ? `calc(${minElementSize}px + (${maxElementSize} - ${minElementSize}) * ((100vw - ${minViewportWidth}px) / (${maxViewportWidth} - ${minViewportWidth})))` + !!maxViewportWidth && + !!unit + ? `calc( + ${minElementSize}${unit} + (${maxElementSize} - ${minElementSize}) * + ((100vw - ${minViewportWidth}${unit}) / (${maxViewportWidth} - ${minViewportWidth})) + )` : ''; } From 4d4e67f4b3ee6ab721a1c4f12e555c5293abd763 Mon Sep 17 00:00:00 2001 From: heyjul3s Date: Tue, 12 Jan 2021 13:30:29 +1100 Subject: [PATCH 2/3] test update --- packages/fluidsizing/__tests__/fluidsizing.test.ts | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/packages/fluidsizing/__tests__/fluidsizing.test.ts b/packages/fluidsizing/__tests__/fluidsizing.test.ts index a0abc29..08972ac 100644 --- a/packages/fluidsizing/__tests__/fluidsizing.test.ts +++ b/packages/fluidsizing/__tests__/fluidsizing.test.ts @@ -4,17 +4,23 @@ describe('fluidSizing - writes sizing CSS rule that dynamically adapts to screen it('should return FALSE by default', () => { const expected = ''; expect( - fluidSizing(void 0 as any, void 0 as any, void 0 as any, void 0 as any) + fluidSizing( + void 0 as any, + void 0 as any, + void 0 as any, + void 0 as any, + void 0 as any + ) ).toEqual(expected); }); it('should return FALSE by when provided falsy arguments', () => { const expected = ''; - expect(fluidSizing(void 0 as any, 96, 300, 1200)).toEqual(expected); + expect(fluidSizing(void 0 as any, 96, 300, 1200, 'px')).toEqual(expected); }); it('should return a CSS string rule', () => { const expected = `calc(48px + (96 - 48) * ((100vw - 300px) / (1200 - 300)))`; - expect(fluidSizing(48, 96, 300, 1200)).toEqual(expected); + expect(fluidSizing(48, 96, 300, 1200, 'px')).toEqual(expected); }); }); From 4391924f07298de0901fe2a84fa2476a69ddd580 Mon Sep 17 00:00:00 2001 From: heyjul3s Date: Tue, 12 Jan 2021 13:54:04 +1100 Subject: [PATCH 3/3] remove whitespace in fluidSizing output --- packages/fluidsizing/src/fluidSizing.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/packages/fluidsizing/src/fluidSizing.ts b/packages/fluidsizing/src/fluidSizing.ts index de11e7f..c604e34 100644 --- a/packages/fluidsizing/src/fluidSizing.ts +++ b/packages/fluidsizing/src/fluidSizing.ts @@ -10,9 +10,6 @@ export function fluidSizing( !!minViewportWidth && !!maxViewportWidth && !!unit - ? `calc( - ${minElementSize}${unit} + (${maxElementSize} - ${minElementSize}) * - ((100vw - ${minViewportWidth}${unit}) / (${maxViewportWidth} - ${minViewportWidth})) - )` + ? `calc(${minElementSize}${unit} + (${maxElementSize} - ${minElementSize}) * ((100vw - ${minViewportWidth}${unit}) / (${maxViewportWidth} - ${minViewportWidth})))` : ''; }