jan/docs/docs/developer/01-overview/03-user-interface.md
2024-03-21 01:02:03 +09:00

1.8 KiB

title slug description keywords
User Interface /developer/ui Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
Jan
Rethink the Computer
local AI
privacy focus
free and open source
private and offline
conversational AI
no-subscription fee
large language models
UI kit

:::warning

This page is still under construction, and should be read as a scratchpad

:::

Jan provides a UI Kit for customize the UI for your use case. This means you can personalize the entire application according to your own brand and visual styles.

This page gives you an overview of how to customize the UI.

You can see some of the user interface components when you first open Jan.

To Link:

  • Ribbon
  • LeftSidebar
  • Main
  • RightSidebar
  • StatusBar

Views

Jan Views TODO: add a better image.

Ribbon

Assistants shortcuts and Modules settings show up here.

import .. from "@jan"
sample code here

LeftSidebar

Conversation threads show up here. This is customizable, so custom assistants can add additional menu items here.

import .. from "@jan"
sample code here

Main

The main view for interacting with assistants. This is customizable, so custom assistants can add in additional UI components. By default, this is a chat thread with assistants.

import .. from "@jan"
sample code here

RightSidebar

A "settings" view for each thread. Users should be able to edit settings or other configs to customize the assistant experience within each thread.

import .. from "@jan"
sample code here

StatusBar

A global status bar that shows processes, hardware/disk utilization and more.

import .. from "@jan"
sample code here