Skip to content

format_status

format_status(
    ctx,
) -> {
    [integer]: {kind: "flat"} | {
                   kind: "zones",
                   left: {
                             [integer]: {
                                            text: string,
                                            fg: number | string?,
                                            bg: number | string?,
                                            bold: boolean?,
                                            italic: boolean?,
                                            underline: boolean?,
                                            dim: boolean?,
                                            reverse: boolean?,
                                            strikethrough: boolean?,
                                        },
                         }?,
                   center: {
                               [integer]: {
                                              text: string,
                                              fg: number | string?,
                                              bg: number | string?,
                                              bold: boolean?,
                                              italic: boolean?,
                                              underline: boolean?,
                                              dim: boolean?,
                                              reverse: boolean?,
                                              strikethrough: boolean?,
                                          },
                           }?,
                   right: {
                              [integer]: {
                                             text: string,
                                             fg: number | string?,
                                             bg: number | string?,
                                             bold: boolean?,
                                             italic: boolean?,
                                             underline: boolean?,
                                             dim: boolean?,
                                             reverse: boolean?,
                                             strikethrough: boolean?,
                                         },
                          }?,
               },
}

Parameters

  • ctx: StatusCtx — the state and stock fragments of the status area

Returns

  • {[integer]: {kind: "flat"} | {kind: "zones", left: {[integer]: {text: string, fg: number | string?, bg: number | string?, bold: boolean?, italic: boolean?, underline: boolean?, dim: boolean?, reverse: boolean?, strikethrough: boolean?}}?, center: {[integer]: {text: string, fg: number | string?, bg: number | string?, bold: boolean?, italic: boolean?, underline: boolean?, dim: boolean?, reverse: boolean?, strikethrough: boolean?}}?, right: {[integer]: {text: string, fg: number | string?, bg: number | string?, bold: boolean?, italic: boolean?, underline: boolean?, dim: boolean?, reverse: boolean?, strikethrough: boolean?}}?}}