Giter Club home page Giter Club logo

react-lumino-widget's Introduction

Lumino Widgets + React/Redux

demo animation

This project is an example on how to use @lumino/widgets in a React application. Inspired by vue-lumino.

The goal was to have a window management similar to VSCode's, but keep access to Redux State and add new windows via Redux actions. In order to realise this we have keep in mind, that lumino (formerly phosphorjs) manages the windows outside of React.

All the magic happens in Lumino.tsx & widgetsSlice.ts.

Steps to reproduce:

  • Decide what will be a widget in your app, define props for these widgets
    • In my case its {id: string, name: string}, where the ID is used to add/remove a specific widget and the name will be displayed in the tab.
  • Define a redux state for the widgets
    • I wrote my Redux widget handling in widgetsSlice.ts using the modern @redux/toolkit which I love. Each supported widget has its own type that will be used for telling lumino which React component to render.
  • Inherit from luminos Widget class
    • We use our custom class to handle communication between lumino and React through custom events.
  • Initialize luminos Boxpanel and DockPanel during the first render in a useEffect hook. Attach callbacks to the elements custom events to communicate our custom widgets events back to react.
  • Watch the redux widgetstate and add a new widget to the DockPanel when a new widget appears in the state.

Styling

To my opinion custom styling is a rather difficult process when using lumino. But with your browsers DevTools it should be okay. For this demo I replaced the close icon with an "X" and changed the window overlay preview to be blue. Change them add your styles in Lumino.css.

react-lumino-widget's People

Stargazers

 avatar

Watchers

 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.