Skip to content

A plugin for Tailwind CSS v3.2+ that provides utilities for safe area

License

Notifications You must be signed in to change notification settings

ban12-project/tailwindcss-safe-area

 
 

Repository files navigation

@ban12/tailwindcss-safe-area

A plugin for Tailwind CSS v3.2+ that provides utilities for safe area.

Installation

Install the plugin from npm:

npm install @ban12/tailwindcss-safe-area

Then add the plugin to your tailwind.config.js file:

// tailwind.config.js
module.exports = {
  theme: {
    // ...
  },
  plugins: [
    require('@ban12/tailwindcss-safe-area'),
    // ...
  ],
}

Usage

Supported css attributes top right bottom left margin padding margin-inline-start padding-inline-start, pre-setting <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">:

<div class="top-safe mx-safe p-safe"></div>
.top-safe {
  top: env(safe-area-inset-top);
}

.mx-safe {
  margin-right: env(safe-area-inset-right);
  margin-left: env(safe-area-inset-left);
}

.p-safe {
  padding-top: env(safe-area-inset-top);
  padding-right: env(safe-area-inset-right);
  padding-bottom: env(safe-area-inset-bottom);
  padding-left: env(safe-area-inset-left);
}

With max() and @supports

The max() CSS function lets you set the largest (most positive) value from a list of comma-separated expressions as the value of a CSS property value, the @supports CSS at-rule lets you specify CSS declarations that depend on a browser's support for CSS features:

<div class="top-safe-max-1 supports-[padding:max(0px)]:top-safe-max-1"></div>
.top-safe-max-1 {
  top: max(0.25rem, env(safe-area-inset-top));
}
@supports (padding: max(0px)) {
  .supports-\[padding\:max\(0px\)\]\:top-safe-max-1 {
    top: max(0.25rem, env(safe-area-inset-top));
  }
}

Reference

Class name and generated css attribute:

Name CSS
top-safe mt-safe pt-safe [ms | me | ps | pe]-safe-top safe-area-inset-top
right-safe mr-safe pr-safe [ms | me | ps | pe]-safe-right safe-area-inset-right
bottom-safe mb-safe pb-safe [ms | me | ps | pe]-safe-bottom safe-area-inset-bottom
left-safe ml-safe pl-safe [ms | me | ps | pe]-safe-left safe-area-inset-left
mx px safe-area-inset-left | safe-area-inset-right
my py safe-area-inset-top | safe-area-inset-bottom

About

A plugin for Tailwind CSS v3.2+ that provides utilities for safe area

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 94.6%
  • JavaScript 5.4%