def thousands(num: Union[float, str, Decimal], show_decimals=False) -> str
Return a whole number formatted with thousands separator. Optionally, format with 2 decimal points (for a PDF form with the currency symbol already present in the form)
show_decimals, will call
int(num), truncating the decimals instead of
rounding to the closest int.
def tel(phone_number) -> str
Format a phone number so you can click on it to open in your phone dialer
def fa_icon(icon: str,
color: Optional[str] = "primary",
color_css: Optional[str] = None,
size: Optional[str] = "sm",
fa_class: str = "fa-solid") -> str
Display a fontawesome icon inline.
Docassemble allows you to display an icon from fontawesome, but it does not provide control over the size or color of the icon. This function gives you more control over the icon that is inserted.
icon- a string representing a fontawesome icon. The icon needs to be in the free library.
color- can be any Bootstrap color variable. For example:
color_css- allows you to use a CSS code to represent the color, e.g.,
size- used to control the fontawesome size (without the
fa-prefix). Valid values include
xs, the default of
2x1, and the python
None, which defaults to
fa_class- let's you specify the fontawesome class, needed for any icon that isn't the default class of
HTML for a font-awesome icon of the specified size and color.
def space(var_name: str, prefix=" ", suffix="") -> str
If the value as a string is defined, return it prefixed/suffixed. Defaults to prefix of a space. Helps build a sentence with less cruft. Equivalent to SPACE function in HotDocs.
def yes_no_unknown(var_name: str,
Return 'unknown' if the value is None rather than False. Helper for PDF filling with yesnomaybe fields
def number_to_letter(n: Optional[int]) -> str
Returns a capital letter representing ordinal position. E.g., 1=A, 2=B, etc. Appends letters once you reach 26 in a way compatible with Excel/Google Sheets column naming conventions. 27=AA, 28=AB...
Insert HTML for a Bootstrap "collapse" div.
Optionally, you can specify a custom icon to override the defaults:
The default icons are "right caret" which displays when the text is collapsed (
"down caret" which displays when the text is open (
def tabbed_templates_html(tab_group_name: str, *pargs) -> str
Provided a list of templates, create Bootstrap v 4.5 tabs with the
subject as the tab label.
review_action: Optional[str] = None,
thumbs_display: str = "Did we help you?",
str = "Thank you for your feedback. Let us know what we could do better",
submit_review_button: str = "Add your review",
post_review_display: str = "Thank you for your review!") -> str
A widget that allows people to give a quick review (thumbs up and down, with an optional text component) in the middle of an interview without triggering a page reload.
review_action is provided, once you press either of the thumbs, a text input screen with
a submit button appears, and once the text review is submitted (or after the thumbs, if no
review_action was provided), a final "thank you" message is displayed.
up_action- the variable name of an event to be executed on the server if the thumbs up is pressed
down_action- the variable name of an event to be executed on the server if the thumbs down is pressed
review_action- the variable name of an event to be execute on the server when someone submits their text review
thumbs_display- text displayed to user describing the thumbs
review_display- text displayed to user describing the text input
submit_review_button- text on the button to submit their text review
post_review_display- text displayed to user after review is submitted
the HTML string of the widget
Lets you add up the value of variables that are not in a list
def add_records(obj, labels)
List demo interviews in the current package to be run from the landing page
def output_checkbox(value_to_check: bool,
checked_value: str = "[X]",
unchecked_value: str = "[ ]")
Generate a conditional checkbox for docx templates
checked_value- defaults to
[X]but can be set to any string or even a
DAStaticFilewith the image of a checkbox
unchecked_value- opposite meaning of
checked_valueand defaults to
def nice_county_name(address: Address) -> str
If the county name contains the word "County", which Google Address Autocomplete does by default, remove it.