Skip to content

A fully composable React component that reproduces the Star Wars opening crawl.

License

Notifications You must be signed in to change notification settings

liorp/react-star-wars-crawl

 
 

Repository files navigation

GitHub npm bundle size react-star-wars-crawl example

react-star-wars-crawl

react-star-wars-crawl-example

A fully composable React component that reproduces the Star Wars opening crawl.

Credit for the default styling and animation belongs to Geoff Graham, outlined in his excellent article here

Credit for the original package is due to rdubrock

Installation

npm install @liorpo/react-star-wars-crawl

Usage

Simply import the Crawl component. You can use the title, subTitle, and text props to achieve the default Star Wars intro.

import React from 'react';
import Crawl from 'react-star-wars-crawl';

const MyCrawlComponent = () => (
  <Crawl
    title="Episode IV"
    subTitle="A New Hope"
    text="It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire. During the battle, Rebel spies managed to steal secret plans to the Empire’s ultimate weapon, the DEATH STAR, an armored space station with enough power to destroy an entire planet. Pursued by the Empire’s sinister agents, Princess Leia races home aboard her starship, custodian of the stolen plans that can save her people and restore freedom to the galaxy…"
  />
);

You can also pass anything you like as a child.

<Crawl>
  <div>Anything at all</div>
</Crawl>

Available props

All default styles can be overriden. A full list of props:

  • containerStyles
  • textContainerStyles
  • crawlStyles
  • titleStyles
  • subTitleStyles
  • textStyles
  • title
  • subTitle
  • text
  • speed

About

A fully composable React component that reproduces the Star Wars opening crawl.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 75.4%
  • JavaScript 13.0%
  • HTML 7.9%
  • CSS 3.7%