@temir/select-input

This repository has been archived, please use Vue TermUI instead.

English | 简体中文

Vue for CLIs. Build your CLI output using components.

Temir provides the same component-based UI building experience that Vue offers in the browser, but for command-line apps.

It uses Yoga to build Flexbox layouts in the terminal, so most CSS-like props are available in Temir as well. If you are already familiar with Vue, you already know Temir.

Since Temir is a Vue renderer, it means that most of the features of Vue are supported. Head over to Vue website for documentation on how to use it. Only Temir's methods will be documented in this readme.

Install

npm install @temir/core

Usage

<script lang="ts" setup>
import { ref } from '@vue/runtime-core'
import { TBox, TText } from '@temir/core'
const counter = ref(0)
setInterval(() => {
  counter.value++
}, 100)
</script>

<template>
  <TBox>
    <TText color="green">
      {{ counter }} tests passed
    </TText>
  </TBox>
</template>

HMR Support

Contents

• Getting Started

• Components

  • <Text>
  • <Box>
  • <Newline>
  • <Spacer>
  • <Link>
  • <Tab>
  • <Spinner>
  • <SelectInput>
  • 💻 Still working and welcome to contribute.

• Examples

  • hi-temir
    
  • borders
    
  • table
    
  • temir-link
    
  • temir-spinner
    
  • temir-tab
    
  • temir-select-input
    
  • Vitest
    

Getting Started

Use @temir/cli to quickly scaffold a new Temir-based CLI.

mkdir my-temir-cli

cd my-temir-cli

touch main.ts

npm install @temir/cli

# Dev

temir main.ts

# Build

temir build main.ts

You can also check it out this example to get started.Feel free to play around with the example and fork this repl at repl.it sandbox

Temir uses Yoga - a Flexbox layout engine to build great user interfaces for your CLIs using familiar CSS-like props you've used when building apps for the browser. It's important to remember that each element is a Flexbox container. Think of it as if each