Переглянути джерело

Update README

Add readme from updated implementation.
refactor/nx-goober
TheoryOfNekomata 1 рік тому
джерело
коміт
04f064e8d7
1 змінених файлів з 34 додано та 0 видалено
  1. +34
    -0
      README.md

+ 34
- 0
README.md Переглянути файл

@@ -0,0 +1,34 @@
# Viewfinder

Layout scaffolding for Web apps.

This library is made to avoid custom repetitive layout code.

## Usage

See the [kitchen sink](./packages/kitchen-sink) for examples.

The available props per layout are included as a TypeScript declarations file.

## Configuration

There are CSS variables that can be declared in the parent of the `*.Layout` components
(preferably `:root`) for customizing the metrics of the layout:

### `--height-topbar`

Default value: `4rem`

Height of the top bar widget.

### `--size-menu`

Default value: `4rem`

Width or height of the menu, depending on the orientation it is rendered.

### `--color-background`

Default value: `white`

Background colors of several widgets from the library.

Завантаження…
Відмінити
Зберегти