Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 4.61 KB

README.md

File metadata and controls

129 lines (88 loc) · 4.61 KB

Flask-FomanticUI

Build status codecov docstr-cov PyPI PyPI - Downloads Documentation Status Forks star issues GitHub contributors black

Flask-FomanticUI is a collection of Jinja macros for Fomantic UI and Flask for the global style. Very similar to Bootstrap-Flask.

Features

  • Table generation: Render data objects (dict or class objects) to Fomantic UI Table.
  • Paginate generation: Render Flask-SQLAlchemy Pagination object to Fomantic UI Pagination.
  • Form generation: Render Flask-WTF/WTForms form object to Fomantic UI Form, etc.

Requirements

Python 3.8+

Dependecies for this project.

intallation

You can install via pip:

    $> pip install Flask-FomanticUI

Example

Register the extension:

from flask import Flask
# To follow the naming rule of Flask extension, although
# this project's name is Flask-FomanticUI, the actual package
# installed is named `flask_fomanticui`.
from flask_fomanticui import FomanticUI

app = Flask(__name__)
fomantic = FomanticUI(app)

Assuming you have a Flask-WTF form like this:

class LoginForm(FlaskForm):
    username = StringField('Username', validators=[DataRequired(), Length(1, 20)])
    password = PasswordField('Password', validators=[DataRequired(), Length(8, 150)])
    submit = SubmitField()
    remember = BooleanField('Remember me')

Now with the render_ui_form macro:

{% from 'fomanticui/form_ui.html' import render_ui_form %}
<html>
<head>
<!-- Fomantic UI - CSS -->
</head>
<body>

<h2>Login</h2>
{{ render_ui_form(form) }}

<!-- Fomantic UI - JS -->
</body>
</html>

You will get a form like this with only one line code (i.e. {{ render_ui_form(form) }}):

form rendering

When the validation fails, the error messages will be rendered with proper style:

error form rendering

Read the Basic Usage docs for more details.

Links

Authors

  • Ferreira, Juan David

Please submit bug reports, suggestions for improvements and patches via the (E-mail: [email protected]).

Contributors

Credits goes to these peoples:

Official repository and Issues

License

Flask-FomanticUI is free software you can redistribute it and/or modify it under the terms of the MIT License. For more information, you can see the LICENSE file for details.