File size: 6,642 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | import chalk from 'chalk'
import cliBoxes, { type Boxes, type BoxStyle } from 'cli-boxes'
import { applyColor } from './colorize.js'
import type { DOMNode } from './dom.js'
import type Output from './output.js'
import { stringWidth } from './stringWidth.js'
import type { Color } from './styles.js'
export type BorderTextOptions = {
content: string // Pre-rendered string with ANSI color codes
position: 'top' | 'bottom'
align: 'start' | 'end' | 'center'
offset?: number // Only used with 'start' or 'end' alignment. Number of characters from the edge.
}
export const CUSTOM_BORDER_STYLES = {
dashed: {
top: '╌',
left: '╎',
right: '╎',
bottom: '╌',
// there aren't any line-drawing characters for dashes unfortunately
topLeft: ' ',
topRight: ' ',
bottomLeft: ' ',
bottomRight: ' ',
},
} as const
export type BorderStyle =
| keyof Boxes
| keyof typeof CUSTOM_BORDER_STYLES
| BoxStyle
function embedTextInBorder(
borderLine: string,
text: string,
align: 'start' | 'end' | 'center',
offset: number = 0,
borderChar: string,
): [before: string, text: string, after: string] {
const textLength = stringWidth(text)
const borderLength = borderLine.length
if (textLength >= borderLength - 2) {
return ['', text.substring(0, borderLength), '']
}
let position: number
if (align === 'center') {
position = Math.floor((borderLength - textLength) / 2)
} else if (align === 'start') {
position = offset + 1 // +1 to account for corner character
} else {
// align === 'end'
position = borderLength - textLength - offset - 1 // -1 for corner character
}
// Ensure position is valid
position = Math.max(1, Math.min(position, borderLength - textLength - 1))
const before = borderLine.substring(0, 1) + borderChar.repeat(position - 1)
const after =
borderChar.repeat(borderLength - position - textLength - 1) +
borderLine.substring(borderLength - 1)
return [before, text, after]
}
function styleBorderLine(
line: string,
color: Color | undefined,
dim: boolean | undefined,
): string {
let styled = applyColor(line, color)
if (dim) {
styled = chalk.dim(styled)
}
return styled
}
const renderBorder = (
x: number,
y: number,
node: DOMNode,
output: Output,
): void => {
if (node.style.borderStyle) {
const width = Math.floor(node.yogaNode!.getComputedWidth())
const height = Math.floor(node.yogaNode!.getComputedHeight())
const box =
typeof node.style.borderStyle === 'string'
? (CUSTOM_BORDER_STYLES[
node.style.borderStyle as keyof typeof CUSTOM_BORDER_STYLES
] ?? cliBoxes[node.style.borderStyle as keyof Boxes])
: node.style.borderStyle
const topBorderColor = node.style.borderTopColor ?? node.style.borderColor
const bottomBorderColor =
node.style.borderBottomColor ?? node.style.borderColor
const leftBorderColor = node.style.borderLeftColor ?? node.style.borderColor
const rightBorderColor =
node.style.borderRightColor ?? node.style.borderColor
const dimTopBorderColor =
node.style.borderTopDimColor ?? node.style.borderDimColor
const dimBottomBorderColor =
node.style.borderBottomDimColor ?? node.style.borderDimColor
const dimLeftBorderColor =
node.style.borderLeftDimColor ?? node.style.borderDimColor
const dimRightBorderColor =
node.style.borderRightDimColor ?? node.style.borderDimColor
const showTopBorder = node.style.borderTop !== false
const showBottomBorder = node.style.borderBottom !== false
const showLeftBorder = node.style.borderLeft !== false
const showRightBorder = node.style.borderRight !== false
const contentWidth = Math.max(
0,
width - (showLeftBorder ? 1 : 0) - (showRightBorder ? 1 : 0),
)
const topBorderLine = showTopBorder
? (showLeftBorder ? box.topLeft : '') +
box.top.repeat(contentWidth) +
(showRightBorder ? box.topRight : '')
: ''
// Handle text in top border
let topBorder: string | undefined
if (showTopBorder && node.style.borderText?.position === 'top') {
const [before, text, after] = embedTextInBorder(
topBorderLine,
node.style.borderText.content,
node.style.borderText.align,
node.style.borderText.offset,
box.top,
)
topBorder =
styleBorderLine(before, topBorderColor, dimTopBorderColor) +
text +
styleBorderLine(after, topBorderColor, dimTopBorderColor)
} else if (showTopBorder) {
topBorder = styleBorderLine(
topBorderLine,
topBorderColor,
dimTopBorderColor,
)
}
let verticalBorderHeight = height
if (showTopBorder) {
verticalBorderHeight -= 1
}
if (showBottomBorder) {
verticalBorderHeight -= 1
}
verticalBorderHeight = Math.max(0, verticalBorderHeight)
let leftBorder = (applyColor(box.left, leftBorderColor) + '\n').repeat(
verticalBorderHeight,
)
if (dimLeftBorderColor) {
leftBorder = chalk.dim(leftBorder)
}
let rightBorder = (applyColor(box.right, rightBorderColor) + '\n').repeat(
verticalBorderHeight,
)
if (dimRightBorderColor) {
rightBorder = chalk.dim(rightBorder)
}
const bottomBorderLine = showBottomBorder
? (showLeftBorder ? box.bottomLeft : '') +
box.bottom.repeat(contentWidth) +
(showRightBorder ? box.bottomRight : '')
: ''
// Handle text in bottom border
let bottomBorder: string | undefined
if (showBottomBorder && node.style.borderText?.position === 'bottom') {
const [before, text, after] = embedTextInBorder(
bottomBorderLine,
node.style.borderText.content,
node.style.borderText.align,
node.style.borderText.offset,
box.bottom,
)
bottomBorder =
styleBorderLine(before, bottomBorderColor, dimBottomBorderColor) +
text +
styleBorderLine(after, bottomBorderColor, dimBottomBorderColor)
} else if (showBottomBorder) {
bottomBorder = styleBorderLine(
bottomBorderLine,
bottomBorderColor,
dimBottomBorderColor,
)
}
const offsetY = showTopBorder ? 1 : 0
if (topBorder) {
output.write(x, y, topBorder)
}
if (showLeftBorder) {
output.write(x, y + offsetY, leftBorder)
}
if (showRightBorder) {
output.write(x + width - 1, y + offsetY, rightBorder)
}
if (bottomBorder) {
output.write(x, y + height - 1, bottomBorder)
}
}
}
export default renderBorder
|