JSPM

neo.mjs

10.0.0-alpha.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8892
  • Score
    100M100P100Q149964F
  • License MIT

The webworkers driven UI framework

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (neo.mjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme


    Downloads Version License Join the Slack channel Discord Chat PRs Welcome

    Build Ultra-Fast, Scalable, and Extensible Web Apps โšก

    ๐Ÿš€ Break Free from the Main Thread โ€“ Experience True Multi-Threading

    Neo.mjs enables the creation of highly dynamic web applications by running everything inside an App Worker. From components and state providers to view controllers, everything operates within the worker, allowing the main thread to focus only on DOM updates and delegating UI events. This ensures high performance, smooth reactivity, and extensibility for both multi-window and SPA applications.



    ๐Ÿ” Why Neo.mjs?

    Neo is a worker thread-driven frontend framework designed to create multithreaded GUIs using JavaScript. By leveraging the Off Main Thread (OMT) paradigm, Neo ensures that your applicationโ€™s UI remains responsive, even during computationally intensive tasks.

    Unlike traditional single-threaded frameworks, Neo distributes workloads across multiple threads, unlocking new levels of performance and scalability. Whether youโ€™re building a small app or a large-scale enterprise solution, Neoโ€™s architecture grows with your needs.

    Key Benefits of Neo.mjs

    1. Multithreading for Performance:
      • Neoโ€™s OMT paradigm moves tasks like data processing, state management, and rendering to worker threads, keeping the main thread free for rendering and user interactions.
      • This approach eliminates UI freezes and ensures a smooth user experience, even for complex applications.
    2. Declarative Class Configuration:
      • Neoโ€™s class config system allows you to define and manage classes in a clean, reusable way. This reduces boilerplate code and makes your codebase more maintainable.
      • With declarative configurations, you can focus on building features instead of wrestling with setup and initialization.
    3. Modular and Scalable Architecture:
      • Neoโ€™s modular design makes it easy to build scalable applications. Components are self-contained and reusable, promoting a clean separation of concerns.
      • Whether youโ€™re building a small app or a large-scale enterprise solution, Neoโ€™s architecture grows with your needs.
    4. Ease of Use:
      • Neoโ€™s intuitive API and comprehensive documentation make it easy to get started, even for developers new to multithreaded programming.
      • The frameworkโ€™s design prioritizes developer productivity, allowing you to focus on solving real-world problems.
    5. Future-Proof Technology:
      • Neo is built on modern web standards like JavaScript modules and worker threads, ensuring compatibility with the latest browser features.
      • By embracing the OMT paradigm, Neo is uniquely positioned to take advantage of future advancements in web development.

    Real-World Applications

    Neo is ideal for:

    • Data-intensive applications: Handle large datasets and complex calculations without compromising UI responsiveness.
    • Real-time dashboards: Build dynamic, real-time dashboards that update seamlessly.
    • Enterprise solutions: Scale your application to meet the demands of large organizations.

    Why Choose Neo Over Traditional Frameworks?

    Traditional single-threaded frameworks often struggle with performance bottlenecks, especially when handling complex UIs or large datasets. Neoโ€™s multithreaded architecture addresses these challenges head-on, delivering a responsive and scalable solution for modern web applications.

    With Neo, you get:

    • โœ… Responsive UIs: No more UI freezes or janky animations.
    • ๐Ÿš€ Scalability: Build applications that can handle increasing complexity without compromising performance.
    • ๐Ÿ’ป Developer Productivity: Spend less time optimizing and more time building features.

    ๐ŸŒŸ Key Features

    ๐ŸŽญ Actor Model:
    The App Worker acts as the central actor, handling application state and logic, independent of the main thread. This drives the OMT (off the main thread) paradigm into perfection, since it is keeping the main thread free for non-blocking DOM updates and UI interactions.

    ๐Ÿ”„ Reactive State Management:
    Built-in reactivity allows dynamic, efficient updates between components and state providers.

    โšก Instant JavaScript module based Development Mode:
    Zero builds or transpilations required. Run your app directly in the browser, modify reactive properties in real-time, and see instant updates. This gives you an unmatched debugging experience, saving time and reducing development costs. You can even build entire apps inside the console if you wish.

    ๐Ÿ“Š Hierarchical State Management:
    Seamlessly manage state between parent and child components with nested state providers. Each component binds to the state data from its closest provider, even combining data from multiple providers inside one binding.

    ๐Ÿงฉ Clean Architecture:
    View controllers ensure a separation of concerns, isolating business logic from UI components for easier maintenance and testing.

    ๐ŸŒ Multi-Window & SPAs:
    Easily build and manage complex, highly interactive applications that require multiple windows or traditional SPAs. No native shell required.

    ๐ŸŒ€ Dynamic Component Management:
    Unmount, move, and remount components across the UI or even in separate browser windows โ€” without losing the componentโ€™s state or logic. This runtime flexibility is a game-changer, preserving JS instances while still updating the UI dynamically.

    :dependabot: No npm dependency hell:
    Neo.mjs apps do not need any dependencies at all, just some dev dependencies for tooling.

    ๐Ÿ’ก Perfect for Complex Use Cases

    Need a web-based IDE, banking dashboard, or an enterprise-grade multi-window app? Neo.mjs is built for it.



    ๐Ÿ“ฆ Declarative Class Configuration

    Neoโ€™s class config system allows you to define and manage classes in a declarative and reusable way. This simplifies class creation, reduces boilerplate code, and improves maintainability.

    import Component from '../../src/component/Base.mjs';
    
    class MyComponent extends Component {
        static config = {
            className   : 'MyComponent',
            myConfig_   : 'defaultValue',
            domListeners: {
                click: 'onClick'
            }
        }
    
        afterSetMyConfig(value, oldValue) {
           console.log('myConfig changed:', value, oldValue)
        }
    
        onClick(data) {
            console.log('Clicked!', data)
        }
    }
    
    export default Neo.setupClass(MyComponent);

    With Neo.mjsโ€™s class config system, you can:

    • Define default properties and methods in a clean, structured way.
    • Easily extend and reuse configurations across classes.
    • Keep your codebase organized and scalable.

    For more details, check out the Class Config System documentation.



    ๐Ÿš€ Get Started

    Quick Start

    Run the following command in your terminal, and your new Neo app will be created, the local web server will start, and your app will open in a new browser window:

    npx neo-app@latest

    This one-liner sets up everything you need to start building with Neo, including:

    • A new app workspace.
    • A pre-configured app shell.
    • A local development server.
    • Opening your app inside a new browser window

    ๐Ÿ“– More details? Check out our Getting Started Guide

    ๐Ÿง‘โ€๐ŸŽ“ Make sure to dive into the Learning Section

    ๐Ÿง  The most advanced tutorial to help you with getting up to speed is this one: Earthquakes Tutorial

    Next steps:

    ๐Ÿค Join the Community

    ๐Ÿ’ฌ Have questions? Join our Slack channel and connect with other developers.

    ๐Ÿ› ๏ธ Want to contribute? Check out our Contributing Guide.



    Copyright (c) 2015 - today, Tobias Uhlig