Socket
Socket
Sign inDemoInstall

header-react-ui

Package Overview
Dependencies
181
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    header-react-ui

A react ui library with functional headers


Version published
Weekly downloads
4
Maintainers
1
Created
Weekly downloads
 

Readme

Source

React Header Ui Library

Your hassle-free solution for crafting dynamic headers within your React projects. Say goodbye to the frustration of designing distinct navigation bars for various screen sizes and laboring over intricate effects. With header-react-ui, all the heavy lifting is taken care of, leaving you with a seamless and effortless experience in header creation.

Table of Contents:

  • Installation
  • Usage
  • Props
  • Examples
  • Contributing
  • License

Installation:

npm install header-react-ui

Usage:

For now we have only one component and it is <NavBarDefault/>, but we will add more components in the future.

import React from "react";
import { NavBarDefault } from "header-react-ui";

const App = () => {
  return <NavBarDefault logo={<div>Your Logo Here</div>} />;
};

export default App;

Props

Each component accepts a set of props that allow you to customize its behavior and appearance. Here's a list of available props for each component:

ComponentName

Prop NameTypeDefault ValueDescription
itemsArray of objects (name, link)[ { name: "Home", link: "/" }, { name: "About", link: "/about" }, { name: "Contact", link: "/contact" } ]Navigation items for the sidebar.
logoReactNode<div>Your Logo Here</div>Logo displayed on the left side of the sidebar.
maxHeightnumber100pxMaximum height of the header.
bgColorstringrgb(213, 248, 248)The color of the background for large devices.
bgMobilestringrgb(213, 248, 248)The color of the background for small devices.
positionstringcenterThe postion of the navlinks for the navbar. See example below. All possible values ('left', 'right', 'center')
buttonReactNode<button>button<button/>Pass any button you want to see on the right side of the navbar

Example:

import { ComponentName } from "your-react-ui-library";
const logo = <div>Your Logo Here</div>;
function App() {
  return <NavBarDefault logo={logo} />;
}

Contributing:

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. //visit Contributing.md for more details

License:

MIT

Keywords:

React Header Ui Library React header library, navigation bar, header components, UI components, responsive design, web development, front-end development, navigation menu, mobile-friendly, branding, logo, links, menu items, customizable headers, user interface, modern web, accessibility, styling, theming, cross-browser compatibility, developer-friendly, code reusability, navigation UI, navigation layout, navigation styles, navigation options, header customization, header styles, header theming, header examples, header installation, header usage, header component, header design, header npm package, header version, header updates, header support, header community, open-source, license, MIT license.

Keywords

FAQs

Last updated on 17 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc