Skip to main content

Flask extension to allow easy embedding of Fomantic-UI CSS Framework.

Project description

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: juandavid9a0@gmail.com).

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-FomanticUI-0.0.3.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

Flask_FomanticUI-0.0.3-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

Details for the file Flask-FomanticUI-0.0.3.tar.gz.

File metadata

  • Download URL: Flask-FomanticUI-0.0.3.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for Flask-FomanticUI-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ce203f3ecf3efc16d39af6315b942d03469fe8494d319e2bbb5685d6564e0c86
MD5 365bed18214501ee312540c39e2577ce
BLAKE2b-256 8393d6ec09f91770633a63d5c96623df3ecd3dd6e82b78580f43c7177391654f

See more details on using hashes here.

File details

Details for the file Flask_FomanticUI-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_FomanticUI-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bc2caab272671195d08865b123e6727be1b2e4b126d14558e8565c313443b9f5
MD5 e4b8b05cac62a9c2ebdfe299a94e8edd
BLAKE2b-256 a696c176bd00b62adf73d9d7a3269bfae00210994d231767c5672494729b5e93

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page