buttons.templatetags package

Submodules

buttons.templatetags.buttons_tags module

Template tags to display buttons in pages

creationdate:09/01/2017 09:21
moduleauthor:François GUÉRIN <fguerin@ville-tourcoing.fr>
modulename:forms.models
class buttons.templatetags.buttons_tags.IconPosition[source]

Bases: enum.Enum

Icon positions enumeration

LEFT = u'LEFT'
NONE = u'NONE'
RIGHT = u'RIGHT'
buttons.templatetags.buttons_tags.btn_back(text=<django.utils.functional.__proxy__ object>, icon=u'chevron-left', icon_position=<IconPosition.LEFT: u'LEFT'>, btn_css_color=u'btn-primary', **kwargs)[source]

Displays a btn_back button

Parameters:
  • btn_css_class: Button bootstrap class
Returns:Render-able dict
buttons.templatetags.buttons_tags.btn_button(**kwargs)[source]

Displays a default button

Parameters:kwargs – Additional keyword args in:
  • text: Button text, default ‘Button’
  • url: Target URL, if needed
  • icon: Button icon, default None
  • icon_position: Button icon position, , default None, aka no icon displayed
  • btn_css_class: Button bootstrap class
  • btn_id: Button Id
  • btn_url: Button url. If set, a a tag us used instead of button
  • dismiss: If True, the
Returns:Render-able dict
buttons.templatetags.buttons_tags.btn_close(btn_css_color=u'btn-warning')[source]
buttons.templatetags.buttons_tags.btn_download(url, text=<django.utils.functional.__proxy__ object>, icon=u'download', icon_position=<IconPosition.RIGHT: u'RIGHT'>, **kwargs)[source]

Displays a download button

Parameters:
  • url – Mandatory target url
  • text – Button text
  • icon – Button icon
  • kwargs – Additional keyword args in:
  • btn_css_class: Button bootstrap class
Returns:Render-able dict
buttons.templatetags.buttons_tags.btn_home(url=u'/', text=<django.utils.functional.__proxy__ object>, icon=u'home', icon_position=<IconPosition.LEFT: u'LEFT'>, btn_css_color=u'btn-primary', **kwargs)[source]

Displays a btn_back btn_button

Parameters:
  • url – Target URL, default ‘/’
  • text – Button text, default ‘Home’
  • icon – Button icon, default ‘fa-home’
  • icon_position – Button icon position, default buttons.templatetags.buttons_tags.IconPosition.RIGHT
  • btn_css_color – Button bootstrap class, default ‘btn-primary’
  • kwargs – Additional keyword args
Returns:

Render-able dict

Displays a simple link btn_button

Parameters:
  • url – Mandatory target url
  • text – link text, default ‘link’
  • icon – Icon label, default ‘link’
  • icon_position – Button icon position, default buttons.templatetags.buttons_tags.IconPosition.RIGHT
  • btn_css_color – Button bootstrap class, default ‘btn-default’
  • kwargs –
Returns:

Render-able dict
buttons.templatetags.buttons_tags.btn_list(url, text=<django.utils.functional.__proxy__ object>, icon=u'list', btn_css_color=u'btn-primary', **kwargs)[source]

Displays a list button

Parameters:
  • url – Mandatory target url
  • text – Button text, default ‘Submit’
  • icon – Button icon, default ‘check’
  • btn_css_color – Base button color
  • kwargs – Additional keyword args
Returns:

Render-able dict
buttons.templatetags.buttons_tags.btn_login(url, text=<django.utils.functional.__proxy__ object>, icon=u'login', **kwargs)[source]
buttons.templatetags.buttons_tags.btn_submit(text=<django.utils.functional.__proxy__ object>, icon=u'check', btn_css_color=u'btn-primary', **kwargs)[source]

Displays a submit button

Parameters:
  • text – Button text, default ‘Submit’
  • icon – Button icon, default ‘check’
  • btn_css_color – Base button color
  • kwargs – Additional keyword args
Returns:

Render-able dict