README.md

HelmetJs is a React package to generate a football helmet given a user's input. It also has a free editor at https://tomkennedy22.github.io/Helmet

Using in TSX

Define your helmetConfig

const helmetConfig = {
  "flipHelmet":false,
  "helmetColor":"#ffdc30",
  "facemaskColor":"#936afe",
  "helmetLogoUrl":"Your URL here",
  "xAdjust":0,
  "yAdjust":0,
  "enableLogo":false,
  "flipLogoWithHelmet":false,
  "useFlippedLogoUrlWhenFlipped":false,
  "helmetStyle":"Standard",
  "tigerStripeColor":"#d18126",
  "wingColor":"#272727",
  "hornColor":"#ffffff",
  "helmetLogoScale":1
}

Or if you have just a few attributes in mind, specify those and get a mostly-blank slate

const helmetConfig = generateHelmetConfigFromOverrides({helmetConfigOverrides:{
  helmetColor: "#0f0",
}})

Then simply include the Helmet component in your app

<Helmet helmetConfig={helmetConfig}/>

Helmet Styles

• Standard
• Tiger Stripe
• Horn
• Wing

Examples

Credit:

• Largely inspired by dumbmatter's https://github.com/zengm-games/facesjs
• HeroUI
• Vite
• Tailwind
• Several other tools