Command/setupframed

Unofficial ConTeXt Wiki mirror

Last modified: 2025-10-08

Summary

The command \setupframed is used for configuring \framed and instances of framed

Settings

\setupframed[...,...][...=...,...]
[...,...] name
corner rectangular round number
framecorner rectangular round number
backgroundcorner rectangular round number
radius dimension
frameradius dimension
backgroundradius dimension
depth dimension
framedepth dimension
backgrounddepth dimension
framecolor color
topframe on off small name
bottomframe on off small name
leftframe on off small name
rightframe on off small name
region yes no
rulethickness dimension
frameoffset dimension
frame on off overlay small closed none
background foreground color name
backgroundoffset frame dimension
backgroundcolor
component name
extras command
foregroundstyle style command
foregroundcolor color
setups name
offset default overlay none dimension
width local fit max broad fixed dimension
height fit max broad dimension
minheight dimension
align see \setupalign
strut yes no none local global
autostrut yes no
location height depth high low top middle bottom line lohi hanging keep formula mathematics normal
autowidth yes no force
lines number
top command
bottom command
blank yes no
profile name
empty yes no
loffset dimension
roffset dimension
toffset dimension
boffset dimension
orientation number
anchoring normal up down left right top bottom name
xanchor dimension
yanchor dimension
linedirection normal reverse

Option Explanation
corner
This option determines whether or not the corners of the frame and background are rounded. It also allows drawing only selected corners. See the example below.
rectangular square corners
round rounded corners
framecorner
This option applies only to the frame corners.
backgroundcorner
This option applies only to the background corners.
radius
background and frame corner radius, if corner=round
frameradius
frame radius, if framecorner=round
backgroundradius
background radius, if backgroundcorner=round
framecolor
line color
topframe
on show upper border
off don’t show
bottomframe
on show lower border
off don’t show
leftframe
on show left border
off don’t show
rightframe
on show right border
off don’t show
rulethickness
sets the thickness of the frame border (line width).
frameoffset
Gives frame an extra offset without affecting surrounding text.
frame
This option determines whether a frame is drawn or not. Option "dash" for dashed lines is new since LMTX 2024-02-22, set dashstep to a dimension to change the pattern.
on show border
off don’t show
background
color a color, to be set with backgroundcolor
name a named background, use \defineoverlay
backgroundoffset
Gives background an extra offset without affecting surrounding text.
backgroundcolor
A color, only used if background=color
offset
This is the offset around the framed content. The frame itself is controlled by frameoffset
default set to 0.25ex.
overlay set to 0pt. If the frame is inside another one then the frame lines will overlap.
none set to 0pt. If the frame is inside another frame then the frame lines are doubled.
width
Specifies the width of the element.
local inherit the width from parent box
fit according to content
broad sets width to approximately \textwidth
fixed like fit, but with an implied autowidth=no
height
Specifies the height of the frame.
align
If the align parameter is unspecified, \framed produces a \hbox, inside which linebreaks (if any) will appear as spaces; when align is specified, \framed will produce a \vbox that allows for multi line text.
strut
ensure that the height is at least a full line height including height and depth
location
depth lower framed box about \strutdp.
low (resembles \inframed): lowers the framed box by about \strutdp+offset+framelinewidth.
hanging lower framed box by approx. its own height (baseline is on the top).
empty
yes do not display contents of the box.
loffset
override the left value of offset
roffset
override the right value of offset
toffset
override the top value of offset
boffset
override the bottom value of offset
orientation
rotation in degrees

Description

Set the default parameters for \framed . The \framed command produces a box with (optionally) a frame, certain dimensions, a background, etc.

Examples

corner option values

This option determines whether or not the corners are round. It also allows drawing only selected corners.

Default value: rectangular
Most common alternative: round
Other values: any number between 0 and 33

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: