TypeScript icon, indicating that this package has built-in type declarations

1.0.8 • Public • Published

nlux REACT 🌲✨💬

Free And Open Source Docs nlux.ai

The Conversational AI UI Library For Any LLM

nlux (for Natural Language User Experience) is an open-source React and Javascript library that makes it super simple to integrate powerful large language models (LLMs) like ChatGPT into your web app or website. With just a few lines of code, you can add conversational AI capabilities and interact with your favourite LLM.

Key Features 🌟

  • Build AI Chat Interfaces In Minutes ― High quality conversational AI interfaces with just a few lines of code.
  • React Components & Hooks<AiChat /> for UI and useChatAdapter hook for easy integration.
  • LLM Adapters ― For ChatGPT / LangChain 🦜 LangServe / HuggingFace 🤗 Inference.
  • A flexible interface to Create Your Own Adapter for any LLM or API.
  • Bot and User Personas ― Customize the bot and user personas with names, images, and more.
  • Streaming LLM Output ― Stream the chat response to the UI as it's being generated.
  • Customizable Theme - Easily customize the look and feel of the chat interface using CSS variables.
  • Event Listeners - Listen to messages, errors, and other events to customize the UI and behaviour.
  • Zero Dependencies ― Lightweight codebase, with zero-dep except for LLM front-end libraries.

200+ Unit Tests

Docs & Examples 📖

Get Started With nlux React 🚀

The example below demonstrates how to create an AI chat interface using nlux React and LangChain, the open source framework for building LLM backends. But you can use nlux with any LLM ― either via the standard adapters provided, or by creating your own adapter.

To get started with nlux React and LangChain, install the @nlux/react and @nlux/langchain-react packages:

npm install @nlux/react @nlux/langchain-react

Then include <AiChat /> in your React app to get started.
Use the useChatAdapter hook to configure an adapter for your LLM.

import {AiChat} from '@nlux/react';
import {useChatAdapter} from '@nlux/langchain-react';

const App = () => {
    const gptAdapter = useChatAdapter({
        url: 'https://<Your LangServe Runnable URL>'

    return (
                placeholder: 'How can I help you today?'
                historyPayloadSize: 'max'

You should also include the nlux theme CSS file in your HTML page or import it in your React app.

And The Result Is ✨

An AI chatbot, powered by LangChain, that can understand and respond to user messages:

nlux AiChat Component

Theme File and CSS 🎨

You should include a theme CSS file into your HTML page.
The recommended way for React developers is to install @nlux/themes

npm install @nlux/themes

Then import the theme CSS file into your app or component as follows:

import '@nlux/themes/nova.css';

This requires that your bundler is configured to load CSS files.

Package Sidebar


npm i @nlux/react



Weekly Downloads






Unpacked Size

34.3 kB

Total Files


Last publish


  • shichri