@tygr/header
v2.0.2
Published
Header for tygr
Downloads
13
Readme
Tygr Header
This is a react component packaged for three environments: node, browser, and standalone.
Node is reccommended. If you are already using react in the project, this library simply exports a react component function you can use directly in jsx.
Browser is for fast prototyping in the browser. You can add this component via a script tag. The react and react-dom script tags must be placed before the component script.
Standalone is for projects that do not use react. It exposes the
mountfunction, which takes an HTML element.
Node
Installation:
npm i --save @tygr/headerUsage (jsx):
import Header from '@tygr/header';
// Import styles. Make sure there is a style loader specified in your
// webpack config
import '@tygr/header/lib/tygr-header.min.css';
export default function MyComponent() {
return (
<div>
<h1>Header usage example</h1>
<Header />
</div>
);
}Browser
Usage:
When included via script tag, the component is exposed as a window library named 'TygrHeader'
<html>
<head>
<script src="https://unpkg.com/react@16/umd/react.development.js"></script>
<script src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
<script src="https://tylergrinn.github.io/tygr-header/lib/tygr-header.min.js"></script>
<link
rel="stylesheet"
href="https://tylergrinn.github.io/tygr-header/lib/tygr-header.min.css"
/>
</head>
<body>
<div id="app"></div>
<script type="text/babel">
ReactDOM.render(<TygrHeader />, document.getElementById('app'));
</script>
</body>
</html>Standalone
Installation:
npm i --save @tygr/headerUsage:
// Vanilla JS
import Header from '@tygr/header/lib/standalone';
const el = document.getElementById('tygr-header');
Header.mount(el);
// Vue
<template>
<div>
<div ref="tygr-header"></div>
</div>
</template>
<script>
import Header from '@tygr/header/lib/standalone';
export default {
mounted() {
Header.mount(this.$refs['tygr-header']);
},
};
</script>
// Angular Typescript
import { Component, ElementRef, ViewChild } from '@angular/core';
import Header from '@tygr/header/lib/standalone';
@Component({
selector: 'app-root',
template: '<div><div #tygr-header></div></div>',
})
export class HeaderComponent {
@ViewChild('tygr-header') el: ElementRef;
ngAfterViewInit() {
Header.mount(this.el.nativeElement);
}
}You should not use the standalone version if you have multiple react components in your project.
Customizing styles
Sass variables can be overridden if you accept responsibility for transpiling it into css. You can see an example of this setup in the webpack.config.demo.js configuration named sass.
Make sure to reassign any sass variables before importing the main.scss file:
$accent-1: white;
$accent-2: yellow;
@import '@tygr/header/sass';