react-shadow-text v1.1.0

react-shadow-text 🌚🌞

A customizable react component that renders text with a shadow. View Demo.

Installation

Install react-shadow-text from npm:

npm i --save react-shadow-text

Getting Started

react-shadow-text is used to render text with a shadow.

import ShadowText from 'react-shadow-text';

class Component extends React.Component {
  render() {
    return (
      <ShadowText>
        🌚 This text has a shadow 🌞
      </ShadowText>
    );
  }
}

Props

react-shadow-text takes the following optional props:

• anchorShadow: Boolean - Whether to anchor the text shadow or not. Defaults to false.
• blurShadow: Boolean - Whether to blur the text shadow or not. Defaults to true.
• className: String - An optional additional classname to give the component.
• theme: Object - Optional theme overrides for component.
• *: Any - Any other prop will be passed through to the component.

Customizing the Component

There are a few ways to customize the react-shadow-text component.

Via theming

The component may be styled by passing a theme using the theme prop.

<ShadowText theme={{
  shadowTextColor: 'MediumSeaGreen',
  shadowTextShadowColor: 'SandyBrown',
  shadowTextShadowBlur: '5px',
  shadowTextXTranslate: '0px',
  shadowTextYTranslate: '-10px',
  shadowTextZIndex: 3,
  shadowTextTransitionDuration: '0.4s',
  shadowTextTransitionTiming: 'ease-in-out',
}}>
  🌚 This text has a shadow 🌞
</ShadowText>

The theme may also be passed in by a <ThemeProvider />:

<ThemeProvider theme={{ shadowTextXTranslate: '20px' }}>
  <ShadowText>
    🌚 This text has a shadow 🌞
  </ShadowText>
</ThemeProvider>

Via CSS Custom Properties

The component may be styled using CSS Custom Properties.

// styles.css

.HoverText--custom {
  --shadow-text-color: FireBrick;
  --shadow-text-shadow-color: CornflowerBlue;
  --shadow-text-shadow-blur: 10px;
  --shadow-text-x-translate: 5px;
  --shadow-text-y-translate: -5px;
  --shadow-text-z-index: 0;
  --shadow-text-transition-duration: 0.2s;
  --shadow-text-transition-timing: ease-out;
}

.HoverText--custom:hover {
  --shadow-text-shadow-blur: 0px;
  --shadow-text-x-translate: 0px;
  --shadow-text-y-translate: 0px;
}

// component.js

<ShadowText className="HoverText--custom">
  🌚 This text has a shadow 🌞
</ShadowText>

Via stylesheets

The component may be styled using by using its CSS classes.

// styles.css
.HoverText {
  font-size: 100px;
}

.HoverText__Text {
  color: OliveDrab;
}

.HoverText__Shadow {
  color: BlanchedAlmond;
}

// component.js

<ShadowText>
  🌚 This text has a shadow 🌞
</ShadowText>

Because of specifity issues, the className might have to be repeated.

Via style prop

Because all props get passed down to the component, some styling may be applied through the style prop:

<ShadowText style={{ fontSize: '3rem' }}>
  🌚 This text has a shadow 🌞
</ShadowText>