npm.io
16.1.2 • Published 8h ago

@tempots/ui

Licence
Apache-2.0
Version
16.1.2
Deps
0
Size
141 kB
Vulns
0
Weekly
0
Stars
15

Tempo UI (@tempots/ui)

A collection of reusable UI components and renderables built on top of @tempots/dom to accelerate development with Tempo. This package provides higher-level abstractions for common UI patterns and components.

npm version license codecov CI

Installation

# npm
npm install @tempots/dom @tempots/std @tempots/ui

# yarn
yarn add @tempots/dom @tempots/std @tempots/ui

# pnpm
pnpm add @tempots/dom @tempots/std @tempots/ui

Note: @tempots/dom and @tempots/std are peer dependencies and must be installed alongside @tempots/ui.

Features

UI Components

The library provides a set of reusable UI components:

import { html, render } from '@tempots/dom'
import { AutoFocus, AutoSelect, InViewport } from '@tempots/ui'

// Create an input that automatically gets focus
const focusedInput = html.input(
  AutoFocus(), // Automatically focus this input when rendered
  AutoSelect()  // Automatically select all text when focused
)

// Create an element that detects when it's in the viewport
const lazyLoadedContent = InViewport(
  {}, // Options for intersection observer
  (isVisible) => isVisible.value
    ? html.div('Content is visible!')
    : html.div('Loading...')
)

render(html.div(focusedInput, lazyLoadedContent), document.body)
Routing

The library includes a simple but powerful routing system:

import { render } from '@tempots/dom'
import { Router, Location } from '@tempots/ui'

const AppRouter = Router({
  '/': () => html.div('Home Page'),
  '/about': () => html.div('About Page'),
  '/users/:id': (info) => {
    // Access route parameters
    const userId = info.$.params.$.id
    return html.div('User Profile: ', userId)
  },
  '*': () => html.div('404 - Not Found')
})

render(AppRouter, document.body)

// Navigate programmatically
Location.navigate('/about')
Query Loading

Handle async data loading with built-in loading and error states:

import { html, prop, render } from '@tempots/dom'
import { Query } from '@tempots/ui'

// Load data from an API
const userId = prop(1)

const userProfile = Query({
  request: userId,
  load: async ({ request, abortSignal }) => {
    const response = await fetch(`/api/user/${request}`, { signal: abortSignal })
    if (!response.ok) throw new Error('Failed to load user')
    return response.json()
  },
  convertError: error => error instanceof Error ? error.message : String(error),
  pending: () => html.div('Loading user...'),
  failure: ({ error }) => html.div(error.map(message => `Error: ${message}`)),
  success: ({ value }) => html.div(
    html.h2(value.map(u => u.name)),
    html.p(value.map(u => u.email)),
  ),
})

render(userProfile, document.body)
PopOver with Arrow Support

Create floating popover elements with optional arrow indicators:

import { html, render, prop, on, attr } from '@tempots/dom'
import { PopOver } from '@tempots/ui'

function TooltipExample() {
  return html.div(
    PopOver((open, close) => {
      return html.button(
        on.click(() => open({
          content: html.div(
            attr.style('padding: 8px; background: white; border-radius: 4px; box-shadow: 0 2px 8px rgba(0,0,0,0.1);'),
            'This is a tooltip with an arrow!'
          ),
          placement: 'top',
          arrowPadding: 4,
          arrow: (arrowSignal) => html.div(
            attr.class('tooltip-arrow'),
            attr.style('background: white; border: 1px solid #ccc; transform: rotate(45deg); width: 8px; height: 8px;')
          ),
          onClickOutside: close,
        })),
        'Click me'
      )
    })
  )
}
Form Helpers

Simplify form input handling:

import { html, render, prop } from '@tempots/dom'
import { SelectOnFocus, AutoSelect } from '@tempots/ui'

function LoginForm() {
  const username = prop('')
  const password = prop('')

  return html.form(
    html.div(
      html.label('Username'),
      html.input(
        AutoFocus(),
        SelectOnFocus(),
        attr.value(username),
        on.input(e => username.set(e.target.value))
      )
    ),
    html.div(
      html.label('Password'),
      html.input(
        attr.type('password'),
        attr.value(password),
        on.input(e => password.set(e.target.value))
      )
    ),
    html.button('Login')
  )
}

Available Components

The library includes the following components and utilities:

  • AutoFocus - Automatically focus an element
  • AutoSelect - Automatically select text in an input
  • SelectOnFocus - Select all text when an input is focused
  • InViewport - Detect when an element is in the viewport
  • Router - Simple client-side routing
  • Location - Navigation and location utilities
  • Query - Async data loading with loading/error states
  • AsyncResultView - Display async operation results
  • ResultView - Display success/failure results
  • PopOver - Create popup/popover elements
  • And more...

Documentation

For comprehensive documentation, visit the Tempo Documentation Site.

License

This package is licensed under the Apache License 2.0.

Keywords