Giter Club home page Giter Club logo

react-window-titlebar's Introduction

React Window Titlebar

React Window Titlebar for your electron applications.

In Action

React Window Titlebar

How to install

$ npm install react-window-titlebar

Usage

import TitleBar from 'react-window-titlebar'; // import TitleBar
import {remote} from 'electron'; // get remote object from electron which helps Titlebar to control window actions
// your component
render () {
    return (
        <TitleBar title="The main window title" remote={remote} theme="dark" />
    )
}
// isn't it is so easy ?

Props

title ( String )

Use this to pass a title to toolbar.

remote ( Object )

This is a required prop. TitleBar uses it to control window actions like closing the window.

theme ( String )

Two themes are available out of the box light & dark. Default is light.

  • light ( default )
  • dark

style ( Object )

Custom style object to control inline styling of the titlebar.

className ( String )

Provide a custom class to titleBar.

hideControls ( Boolean )

Set hideControls true to hide window contol buttons. False by default.

actionsPos ( String )

actionsPos controls where should window control buttons will render. The two available options are :-

  • left ( default )
  • right

buttons ( Array of Elements )

You can pass array of elements to buttons which will be rendered in opposite side of window controls. I made this for passing additional buttons but you can pass any React element into it.

let sideButtons = [
	<button className="btn btn-default">
		<Icon name="sliders" />
	</button>
];
<TitleBar remote={remote} title={title} theme="light" buttons={sideButtons}/>

Contribte to this component

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull against dev branch :D

When developing your feature you can take advantage of npm run dev script provided in package.json. If you want to test this component run npm run dev inside your development folder & then inside your electron project directory run npm link react-window-titlebar. Now you will be able to import react-window-titlebar like a normal npm module.

Whenever you make a change just run npm run dev again.

About Me

react-window-titlebar's People

Contributors

manojsinghnegiwd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.