Skip to main content

insta-ui is a Python-based UI library for rapidly building user interfaces.

Project description

insta-ui

English| 简体中文

📖 Introduction

insta-ui is a Python-based UI library for quickly building user interfaces.

⚙️ Features

Three modes:

  • Web mode: Generate web (stateless) applications.
  • Web View mode: Generate web view applications that can be packaged as native apps (no need to start a web server).
  • Zero mode: Generate pure HTML files that run directly in browsers without any dependencies.

📦 Installation

Zero mode:

pip install instaui -U

web mode

pip install instaui[web] -U

Web View mode

pip install instaui[webview] -U

🖥️ Quick Start

Below is a simple example of number summation. The result color changes dynamically based on the sum:

from instaui import ui, arco
arco.use()

@ui.page('/')
def home():
    num1 = ui.state(0)
    num2 = ui.state(0)

    # Automatically recalculates result when num1 or num2 changes 
    @ui.computed(inputs=[num1, num2])
    def result(num1: int, num2: int):
        return num1 + num2

    # Automatically updates text_color when result changes
    @ui.computed(inputs=[result])
    def text_color(result: int):
        return "red" if result % 2 == 0 else "blue"

    # UI components  
    arco.input_number(num1)
    ui.text("+")
    arco.input_number(num2)
    ui.text("=")
    ui.text(result).style({"color": text_color})

# when you deploy your web application, you need to set debug=False.
ui.server(debug=True).run()

Replace ui.server().run() with ui.webview().run() to switch to Web View mode:

...

# ui.server(debug=True).run()
ui.webview().run()

To execute computations on the client side instead of the server, use ui.js_computed instead of ui.computed:

from instaui import ui, arco
arco.use()

@ui.page('/')
def home():
    num1 = ui.state(0)
    num2 = ui.state(0)

    result = ui.js_computed(inputs=[num1, num2], code="(num1, num2) => num1 + num2")
    text_color = ui.js_computed(inputs=[result], code="(result) => result % 2 === 0? 'red' : 'blue'")

    # UI components
    ...

...

In this case, all interactions will run on the client side. Use Zero mode to generate a standalone HTML file:

from instaui import ui, arco,zero
arco.use()

@ui.page('/')
def home():
    num1 = ui.state(0)
    num2 = ui.state(0)

    result = ui.js_computed(inputs=[num1, num2], code="(num1, num2) => num1 + num2")
    text_color = ui.js_computed(inputs=[result], code="(result) => result % 2 === 0? 'red' : 'blue'")

    # UI components
    arco.input_number(num1)
    ui.text("+")
    arco.input_number(num2)
    ui.text("=")
    ui.text(result).style({"color": text_color})

with zero() as z:
    home()
    z.to_html('index.html')

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

instaui-0.4.1.tar.gz (577.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

instaui-0.4.1-py3-none-any.whl (651.3 kB view details)

Uploaded Python 3

File details

Details for the file instaui-0.4.1.tar.gz.

File metadata

  • Download URL: instaui-0.4.1.tar.gz
  • Upload date:
  • Size: 577.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.6

File hashes

Hashes for instaui-0.4.1.tar.gz
Algorithm Hash digest
SHA256 a9dbadf99c0ae9e0ff9399f3e77c251dc3e9c9d7b91483410c73223e3c7794ac
MD5 856f00908b473cb994f49dd132726c01
BLAKE2b-256 e1e5a263379ba8e27e7288d75f97cd9e067fd2b1568cc6b7fc02df087961a545

See more details on using hashes here.

File details

Details for the file instaui-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: instaui-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 651.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.6

File hashes

Hashes for instaui-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c9e81de6f7b51fea1ddc6275c6fcb3e354cbe33404add8d4b1a7d093427b83b7
MD5 c79bbaf998d2007c4408ddbab5e2fa56
BLAKE2b-256 abe12b866e47aa36610e3f44f6805d169f7c3a51ebfc14aa8ea6209951091fb6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page