useContrastText | NativeBase

NativeBase

3.4.x

⌘

Hire us

NativeBase

Introduction

Getting Started

Installation

Setup NativeBase Provider

Resources

Contribution

Core Concepts

Utility First

Utility Props Specificity

New

Design Tokens

Pseudo Props: Overview

New

Pseudo Props: Dos & Don'ts

Features

Color mode (Dark Mode)

Theme

Customizing Components

Making components dark mode compatible

Layout

Forms

Data Display

Feedback

Typography

Overlay

Disclosure

Media and Icons

Transition

Others

ReactNative Components

Hooks

Examples

Recipes

Designs

Forms

Layout

Migration

Upgrading to 3.2.0 from 3.x

Components Migration

If you are starting a new project, please try gluestack-ui for better performance and new design.

useContrastText

useContrastText is a custom hook used to get a contrasting color (either lightText or darkText) to the color passed as a parameter.

Import

Copy
import { useContrastText } from 'native-base';

Examples

Basic


Playground
const Example = () => {
  const bgDark = "gray.900";
  const bgLight = "gray.50";
  const colorContrastDark = useContrastText(bgDark);
  const colorContrastLight = useContrastText(bgLight);
  return <>
      <Button bg={bgDark} _text={{
      color: colorContrastDark
    }} my={6}>
        NativeBase
      </Button>
      <Button bg={bgLight} _text={{
      color: colorContrastLight
    }}>
        NativeBase
      </Button>
    </>;
};const Example = () => {
  const bgDark = "gray.900";
  const bgLight = "gray.50";
  const colorContrastDark = useContrastText(bgDark);
  const colorContrastLight = useContrastText(bgLight);
  return <>
      <Button bg={bgDark} _text={{
      color: colorContrastDark
    }} my={6}>
        NativeBase
      </Button>
      <Button bg={bgLight} _text={{
      color: colorContrastLight
    }}>
        NativeBase
      </Button>
    </>;
};

Using Accessible Colors

By default, NativeBase provides contrasting colors based on its theme. You can also choose to get colors with better

color and contrast accessibility

with the help of

useAccessibleColors

hook.


Playground
const ButtonTemplate = ({
  shade
}) => {
  const colorContrast = useContrastText(`yellow.${shade}`);
  return <Button colorScheme="yellow" key={`yellow.${shade}`} bg={`yellow.${shade}`} _text={{
    color: colorContrast
  }} mb={1}>
      Save Changes
    </Button>;
};

const Example = () => {
  let [,, toggleAccessibleColors] = useAccessibleColors();
  const {
    colors
  } = useTheme();
  return <>
      {Object.keys(colors.yellow).map((key, index) => {
      if (index > 2 && index < 9) return <ButtonTemplate shade={key} />;
    })}
      <Button mt="10" onPress={toggleAccessibleColors} colorScheme="primary">
        Toggle Accessible Colors
      </Button>
    </>;
};const ButtonTemplate = ({
  shade
}) => {
  const colorContrast = useContrastText(`yellow.${shade}`);
  return <Button colorScheme="yellow" key={`yellow.${shade}`} bg={`yellow.${shade}`} _text={{
    color: colorContrast
  }} mb={1}>
      Save Changes
    </Button>;
};

const Example = () => {
  let [,, toggleAccessibleColors] = useAccessibleColors();
  const {
    colors
  } = useTheme();
  return <>
      {Object.keys(colors.yellow).map((key, index) => {
      if (index > 2 && index < 9) return <ButtonTemplate shade={key} />;
    })}
      <Button mt="10" onPress={toggleAccessibleColors} colorScheme="primary">
        Toggle Accessible Colors
      </Button>
    </>;
};

Return value

Accepts and returns a color defined in the theme.

Quick Nav

Using Accessible Colors

Return value

MadeWithNativeBase

gluestack-ui

useContrastText | NativeBase | Universal Components for React and React Native