@e2agency/ea-fluid-adaptability v1.0.8

@e2agency/ea-fluid-adaptability

Description

The @e2agency/ea-fluid-adaptability package provides a set of SCSS mixins and functions for easy handling of adaptive font and element size changes on a web page.

Examples

• Basic usage
  • CodePen
  • StackBlitz

Installation

Install the package using npm:

npm install @e2agency/ea-fluid-adaptability

Usage

Import the package into your SCSS files:

@use "@e2agency/ea-fluid-adaptability" as *;

Sizes in rem

Use the ea-rem and ea-rem-max functions for working with sizes in rem:

$my-size: ea-rem(20px); // Convert 20px to rem
$max-size: ea-rem-max(30px); // Convert 30px to rem and add the max() function

For full fluid of that variables you should set font-size to html tag with clamp function like that:

font-size: ea-clamp(8, $ea-base-size, 500, 1000) // $ea-base-size is 16 by default

Or keep you html font size same as $ea-base-size variable. To change it use @import instead of @use:

$ea-base-size: 10px;
@import '@e2agency/ea-fluid-adaptability/';

Relative sizes

Use the ea-rel and ea-rel-max functions for working with relative sizes:

You must create variable --ea-font-size to make it work properly, or pass variable name as second argument.

--ea-font-size: #{ea-clamp(8, 16, 500, 1000)};

$rel-size: ea-rel(18px); // Size relative to the base size
$max-rel-size: ea-rel-max(25px); // Relative size with the addition of the max() function

Clamp function

Use the ea-clamp function to create a CSS clamp function with adaptive sizes:

$adaptive-size: ea-clamp(10px, 30px, 500, 1000, "x"); // Create an adaptive size with clamp()

API

See the API documentation for API of functions.

License

MIT License

Copyright (c) 2023 Egorov Agency

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.