@tinyeye/react-ui v0.0.1

TinyEye Component Library

The TinyEye Component Library is a collection of reusable UI components designed to streamline the development process and ensure consistency across applications. This library includes components such as Breadcrumbs, Buttons, Dividers, Input fields, Logos, Menus, Modals, Navigation elements, and Select inputs.

Table of Contents

• Installation
• Usage
• Components
  • Breadcrumbs
  • Buttons
  • Dividers
  • Input
  • Logo
  • Menu
  • Modal
  • Nav
  • Select
• Available Scripts
  • npm start
  • npm test
  • npm run build
  • npm run eject
  • npm run storybook
• Storybook
• Deployment
• Publish

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.\ Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.\ You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.\ It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

npm run storybook

This command starts the Storybook development server, allowing you to view and test components in an isolated environment. It opens a web interface where you can see all the components and their stories.

Installation

To install the TinyEye Component Library, you can use npm or yarn:

npm install tinyeye-component-library
Copy
Insert

or

yarn add tinyeye-component-library
Copy
Insert

Usage

To use a component from the library, import it into your project:

import { Button } from 'tinyeye-component-library'; Copy Insert

You can then use the component in your JSX:

Click Me Copy Insert

Components

Breadcrumbs Provides navigation links to help users understand their location within a hierarchy. Buttons Various styles and sizes of buttons for different use cases. Dividers Horizontal lines to separate content sections. Input Standard input fields for forms. Logo Includes the TinyEye logo in different styles. Menu Components for creating navigation menus, including side menus. Modal Components for creating modal dialogs. Nav Navigation components for building menus and navigation bars. Select Dropdown select inputs for forms.

Storybook

The library includes Storybook stories for each component to help visualize and test them. To run Storybook, use the following command:

npm run storybook

Deployment

To build the project, use the following command:

npm run build

Publish

Finally, we can log in and publish the package to the NPM repository using the following command:

npm login
npm publish