Skip to content

CARD-RU.md

Latest commit

 

History

History
79 lines (62 loc) · 4.33 KB

CARD-RU.md

File metadata and controls

79 lines (62 loc) · 4.33 KB
Raw

api: Главная | Readme

CONSOLE-LAYOUT

# CARD

Утилита, которая позволяет отрисовать карточку с данными. Позволяет рисовать карточку без шапки.

import { card, CardTitle } from 'console-layout';

const cardContext: string[] = [
  'test test test test test test test test test test test test',
  'test test test test test test',
  'test test test test test test test test test test',
  'test test',
  '',
  'test test test test test test test test test test',
];

const cardTitle: CardTitle[] = [
  // CardTitle || CardTitle[]
  { context: 'NAME', textAlign: 'right' },
  { context: 'v2.12.1', textAlign: 'right' },
];

const context = card(cardContext, cardTitle) as string[];
console.log(context.join('\n'));

demo.png

Аргумент Название Тип Обязательность По умолчанию Описание
1 context string[] true - массив строк, который будет отрисовываться внутри карточки
2 title CardTitle | CardTitle[] false [] данные для отрисовки заголовка карточки
3 options CardOptions false - опции карточки

тип CardTitle

Ключ Tип Обязательность По умолчанию Описание
context string | number true - текст элемента
textAlign 'left'| 'right' | 'center' false 'left' положение названия в колонке

тип CardOptions

Ключ Tип Обязательность По умолчанию Описание
borderHorizonChar string false '-' символ горизонтальной линии границы
borderVerticalChar string false '|' символ вертикальной линии границы
borderXChar string false '#' символ пересечения вертикальной и горизонтальной линий
typeResult 'string' | 'array' false 'array' вид возвращаемого значения: строка или массив строк
hidePadding boolean false false убрать внутренний отступ
viewMargin boolean false false отобразить внешний отступ

# Документация