Ring Offset Color

Utilities for setting the color of outline ring offsets.

Default class reference

Usage

Use the ring-offset-{color} utilities to change the color of a ring offset. Usually this is done to try and match the offset to the parent background color, since true box-shadow offsets aren’t actually possible in CSS.

<div class="... bg-purple-100">
  <button class="... ring ring-purple-600 ring-offset-4 ring-offset-purple-100">
    ring-offset-purple-100
  </button>
</div>

Responsive

To control the ring offset color at a specific breakpoint, add a {screen}: prefix to any existing ring offset color utility. For example, use md:ring-offset-blue-500 to apply the ring-offset-blue-500 utility at only medium screen sizes and above.

<button class="ring-2 ring-offset-2 ring-offset-blue-300 md:ring-offset-blue-500">
  <!-- ... -->
</button>

For more information about Tailwind’s responsive design features, check out the Responsive Design documentation.

Customizing

You can customize which ring offset color utilities are generated by customizing your color palette under the colors key in the theme section of your tailwind.config.js file:

// tailwind.config.js
const colors = require('tailwindcss/colors')
module.exports = {
  theme: {
    colors: {
      gray: colors.blueGray,
      indigo: colors.indigo,
      red: colors.rose,
      yellow: colors.yellow,
    }
  }
}

If you’d like to customize only the ring offset color utilities without affecting your global color palette, use the ringOffsetColor key instead:

// tailwind.config.js
const colors = require('tailwindcss/colors')
module.exports = {
  theme: {
    ringOffsetColor: {
      white: colors.white,
      pink: colors.fuchsia,
    }
  }
}

Learn more about customizing the default theme in the theme customization documentation.

Variants

By default, only responsive, dark mode (if enabled), focus-within and focus variants are generated for ring offset color utilities.

You can control which variants are generated for the ring offset color utilities by modifying the ringOffsetColor property in the variants section of your tailwind.config.js file.

For example, this config will also generate hover and active variants:

  // tailwind.config.js
  module.exports = {
    variants: {
      extend: {
        // ...
+       ringOffsetColor: ['hover', 'active'],
      }
    }
  }

Disabling

If you don’t plan to use the ring offset color utilities in your project, you can disable them entirely by setting the ringOffsetColor property to false in the corePlugins section of your config file:

  // tailwind.config.js
  module.exports = {
    corePlugins: {
      // ...
+     ringOffsetColor: false,
    }
  }

←Ring Offset WidthBox Shadow→