Giter Site home page Giter Site logo

koriwi / ha-component-kit Goto Github PK

View Code? Open in Web Editor NEW

This project forked from shannonhochkins/ha-component-kit

0.0 0.0 0.0 152.91 MB

A Home Assistant React component library to generate dashboards with ease, This utilizises a massive list of Components / cards to use out of the box, a large range of hooks to build your own custom functionality, and a hell of a lot more! It's using web sockets to retrieve information from your home assistant instance so there's 0 latency!

Home Page: https://shannonhochkins.github.io/ha-component-kit/

JavaScript 2.93% TypeScript 93.34% CSS 0.06% Dockerfile 0.07% MDX 3.59%

ha-component-kit's Introduction

Overview

This repository contains functionality to easily generate custom dashboards with react for Home Assistant using the official web socket connection that the standard lovelace dashboards use.

Try it out now! Demo

If you like anything here, be sure to ๐ŸŒŸ the repo!

DEMO

@hakit/core Downloads @hakit/components Downloads

Help me out?

As you can probably tell, 100s of hours have gone into this! I'd really appreciate a small donation as it will help me validate that my time is well spent and will guarantee future additional changes :) Buy me a coffee!

Get Started

There's an npm create command which will setup react, typescript, vite & hakit automatically for you with a terminal wizard!

  npm create hakit@latest

Or, if you want to install @hakit/core or @hakit/components manually on an existing project:

  npm install @hakit/core @hakit/components

Documentation

There's extensive documentation which should give you all the information you need to get started!

Home Assistant Addon

There's a Home Assistant Addon available which will serve your dashboard to a new sidebar link in home assistant making it easier to access your custom dashboard.

WIP - Next Release

  • Theming - allow individual components to display different theme control, either by a hue shift or global change

Supported Cards

Known Issues

  • Anything else? Please, if you notice anything that doesn't feel / look right, please report it, i rely on user testing to make improvements.

What's next?

There's a Roadmap.md file with a few things i'm working on! Have your say! Vote for what you'd like to see next in upcoming features!

Contributors!

I welcome anyone who's willing to contribute to the package, if you're interested in helping out or have some suggestions to changes, please feel free to open a PR or an issue!

There's detailed instructions on how to get started if you want to introduce a new feature to the repository here.

ha-component-kit's People

Contributors

shannonhochkins avatar koriwi avatar yann510 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.