flet-toast


Nameflet-toast JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/webtechmoz/flet-toast.git
SummaryCria interface para exibir notificações na tela
upload_time2024-08-27 22:21:49
maintainerNone
docs_urlNone
authorWeb Tech Moz
requires_python>=3.10
licenseMIT
keywords toastfy toasty-flet flet-toast toast flet
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Toastfy - Biblioteca de Notificações Toast para Flet

`Toastfy` é uma biblioteca poderosa e flexível que permite a criação e exibição de notificações do tipo "toast" em aplicações Flet. Com `Toastfy`, você pode facilmente adicionar toasts de sucesso, erro e aviso às suas aplicações, personalizando a posição e o comportamento das notificações.

## Funcionalidades

- **Toasts de Sucesso, Erro e Aviso**: Notificações específicas para diferentes cenários.
- **Posicionamento Personalizável**: Escolha entre várias posições predefinidas na tela.
- **Integração Simples**: Fácil de integrar e usar em qualquer aplicação Flet.

![Diferentes toats gerados](https://raw.githubusercontent.com/webtechmoz/flet-toast/master/assets/float_toast.png)

## Instalação

Para instalar a biblioteca `Toastfy`, execute:

```bash
pip install flet_toast
```
## Exemplo de Uso

Abaixo está um exemplo simples de como utilizar a classe Toastfy em uma aplicação Flet:
```python
import flet as ft
from flet_toast import flet_toast

def main(page: ft.Page):
    page.theme_mode = ft.ThemeMode.LIGHT
    
    control = ft.Row(
        controls=[
            ft.ElevatedButton(
                text='Sucess',
                color=ft.colors.BLUE,
                on_click=lambda e: clicked_sucess(e)
            ),
            ft.ElevatedButton(
                text='Warning',
                color=ft.colors.PURPLE,
                on_click=lambda e: clicked_warning(e)
            ),
            ft.ElevatedButton(
                text='Error',
                color=ft.colors.RED,
                on_click=lambda e: clicked_error(e)
            )
        ]
    )

    def clicked_sucess(e):
        flet_toast.sucess(
            page=page,
            message='Deu sucesso',
            position=flet_toast.Position.TOP_RIGHT,
            duration=5
        )
    
    def clicked_warning(e):
        flet_toast.warning(
            page=page,
            message='Deu warning',
            position=flet_toast.Position.BOTTOM_RIGHT,
            duration=5
        )
    
    def clicked_error(e):
        flet_toast.error(
            page=page,
            message='Deu erro',
            position=flet_toast.Position.BOTTOM_LEFT,
            duration=5
        )

    page.add(control)

if __name__ == '__main__':
    ft.app(target=main)
```

## Documentação

### Métodos
**success**:
Exibe uma notificação toast de sucesso.

- `page`: A página Flet onde o toast será exibido.
- `message`: A mensagem a ser exibida no toast.
- `position`: A posição do toast na tela.
- `duration`: A duração da notificação toast

**error**:
Exibe uma notificação toast de erro.

- `page`: A página Flet onde o toast será exibido.
- `message`: A mensagem a ser exibida no toast.
- `position`: A posição do toast na tela.
- `duration`: A duração da notificação toast

**warning**:
Exibe uma notificação toast de aviso.

- `page`: A página Flet onde o toast será exibido.
- `message`: A mensagem a ser exibida no toast.
- `position`: A posição do toast na tela.
- `duration`: A duração da notificação toast

### Propriedas
**position**:
position define as possíveis posições para exibir as notificações toast na tela. As opções incluem:

- `top_left`: Canto superior esquerdo.
- `top_right`: Canto superior direito.
- `bottom_left`: Canto inferior esquerdo.
- `bottom_right`: Canto inferior direito (padrão).

**duration**:
Define o tempo em que a notificação toast estará visivel na tela. Este deve ser um número inteiro 

## Licença
Este projeto está licenciado sob os termos da licença MIT. Veja o arquivo LICENCE para mais detalhes.

## Contribuições
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests no repositório do GitHub.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/webtechmoz/flet-toast.git",
    "name": "flet-toast",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "toastfy, toasty-flet, flet-toast, toast, flet",
    "author": "Web Tech Moz",
    "author_email": "zoidycine@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/4e/e1/caf206079e92ffaf02d5e5c6539b66de96a397d9f451563f5f27da263e0e/flet_toast-0.3.1.tar.gz",
    "platform": null,
    "description": "# Toastfy - Biblioteca de Notifica\u00e7\u00f5es Toast para Flet\r\n\r\n`Toastfy` \u00e9 uma biblioteca poderosa e flex\u00edvel que permite a cria\u00e7\u00e3o e exibi\u00e7\u00e3o de notifica\u00e7\u00f5es do tipo \"toast\" em aplica\u00e7\u00f5es Flet. Com `Toastfy`, voc\u00ea pode facilmente adicionar toasts de sucesso, erro e aviso \u00e0s suas aplica\u00e7\u00f5es, personalizando a posi\u00e7\u00e3o e o comportamento das notifica\u00e7\u00f5es.\r\n\r\n## Funcionalidades\r\n\r\n- **Toasts de Sucesso, Erro e Aviso**: Notifica\u00e7\u00f5es espec\u00edficas para diferentes cen\u00e1rios.\r\n- **Posicionamento Personaliz\u00e1vel**: Escolha entre v\u00e1rias posi\u00e7\u00f5es predefinidas na tela.\r\n- **Integra\u00e7\u00e3o Simples**: F\u00e1cil de integrar e usar em qualquer aplica\u00e7\u00e3o Flet.\r\n\r\n![Diferentes toats gerados](https://raw.githubusercontent.com/webtechmoz/flet-toast/master/assets/float_toast.png)\r\n\r\n## Instala\u00e7\u00e3o\r\n\r\nPara instalar a biblioteca `Toastfy`, execute:\r\n\r\n```bash\r\npip install flet_toast\r\n```\r\n## Exemplo de Uso\r\n\r\nAbaixo est\u00e1 um exemplo simples de como utilizar a classe Toastfy em uma aplica\u00e7\u00e3o Flet:\r\n```python\r\nimport flet as ft\r\nfrom flet_toast import flet_toast\r\n\r\ndef main(page: ft.Page):\r\n    page.theme_mode = ft.ThemeMode.LIGHT\r\n    \r\n    control = ft.Row(\r\n        controls=[\r\n            ft.ElevatedButton(\r\n                text='Sucess',\r\n                color=ft.colors.BLUE,\r\n                on_click=lambda e: clicked_sucess(e)\r\n            ),\r\n            ft.ElevatedButton(\r\n                text='Warning',\r\n                color=ft.colors.PURPLE,\r\n                on_click=lambda e: clicked_warning(e)\r\n            ),\r\n            ft.ElevatedButton(\r\n                text='Error',\r\n                color=ft.colors.RED,\r\n                on_click=lambda e: clicked_error(e)\r\n            )\r\n        ]\r\n    )\r\n\r\n    def clicked_sucess(e):\r\n        flet_toast.sucess(\r\n            page=page,\r\n            message='Deu sucesso',\r\n            position=flet_toast.Position.TOP_RIGHT,\r\n            duration=5\r\n        )\r\n    \r\n    def clicked_warning(e):\r\n        flet_toast.warning(\r\n            page=page,\r\n            message='Deu warning',\r\n            position=flet_toast.Position.BOTTOM_RIGHT,\r\n            duration=5\r\n        )\r\n    \r\n    def clicked_error(e):\r\n        flet_toast.error(\r\n            page=page,\r\n            message='Deu erro',\r\n            position=flet_toast.Position.BOTTOM_LEFT,\r\n            duration=5\r\n        )\r\n\r\n    page.add(control)\r\n\r\nif __name__ == '__main__':\r\n    ft.app(target=main)\r\n```\r\n\r\n## Documenta\u00e7\u00e3o\r\n\r\n### M\u00e9todos\r\n**success**:\r\nExibe uma notifica\u00e7\u00e3o toast de sucesso.\r\n\r\n- `page`: A p\u00e1gina Flet onde o toast ser\u00e1 exibido.\r\n- `message`: A mensagem a ser exibida no toast.\r\n- `position`: A posi\u00e7\u00e3o do toast na tela.\r\n- `duration`: A dura\u00e7\u00e3o da notifica\u00e7\u00e3o toast\r\n\r\n**error**:\r\nExibe uma notifica\u00e7\u00e3o toast de erro.\r\n\r\n- `page`: A p\u00e1gina Flet onde o toast ser\u00e1 exibido.\r\n- `message`: A mensagem a ser exibida no toast.\r\n- `position`: A posi\u00e7\u00e3o do toast na tela.\r\n- `duration`: A dura\u00e7\u00e3o da notifica\u00e7\u00e3o toast\r\n\r\n**warning**:\r\nExibe uma notifica\u00e7\u00e3o toast de aviso.\r\n\r\n- `page`: A p\u00e1gina Flet onde o toast ser\u00e1 exibido.\r\n- `message`: A mensagem a ser exibida no toast.\r\n- `position`: A posi\u00e7\u00e3o do toast na tela.\r\n- `duration`: A dura\u00e7\u00e3o da notifica\u00e7\u00e3o toast\r\n\r\n### Propriedas\r\n**position**:\r\nposition define as poss\u00edveis posi\u00e7\u00f5es para exibir as notifica\u00e7\u00f5es toast na tela. As op\u00e7\u00f5es incluem:\r\n\r\n- `top_left`: Canto superior esquerdo.\r\n- `top_right`: Canto superior direito.\r\n- `bottom_left`: Canto inferior esquerdo.\r\n- `bottom_right`: Canto inferior direito (padr\u00e3o).\r\n\r\n**duration**:\r\nDefine o tempo em que a notifica\u00e7\u00e3o toast estar\u00e1 visivel na tela. Este deve ser um n\u00famero inteiro \r\n\r\n## Licen\u00e7a\r\nEste projeto est\u00e1 licenciado sob os termos da licen\u00e7a MIT. Veja o arquivo LICENCE para mais detalhes.\r\n\r\n## Contribui\u00e7\u00f5es\r\nContribui\u00e7\u00f5es s\u00e3o bem-vindas! Sinta-se \u00e0 vontade para abrir issues e pull requests no reposit\u00f3rio do GitHub.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Cria interface para exibir notifica\u00e7\u00f5es na tela",
    "version": "0.3.1",
    "project_urls": {
        "Homepage": "https://github.com/webtechmoz/flet-toast.git"
    },
    "split_keywords": [
        "toastfy",
        " toasty-flet",
        " flet-toast",
        " toast",
        " flet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa10506c8fc7020ff6dbf8f3cce974b9acb7a89cc57a642a6b59dce292221e62",
                "md5": "49224796b68a72c7865a63877437c390",
                "sha256": "a8610b6e89e44bbb2d73d6f71f2d324985a204c61b07e9b9fc8494336e51b1b6"
            },
            "downloads": -1,
            "filename": "flet_toast-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49224796b68a72c7865a63877437c390",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6861,
            "upload_time": "2024-08-27T22:21:47",
            "upload_time_iso_8601": "2024-08-27T22:21:47.737019Z",
            "url": "https://files.pythonhosted.org/packages/fa/10/506c8fc7020ff6dbf8f3cce974b9acb7a89cc57a642a6b59dce292221e62/flet_toast-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ee1caf206079e92ffaf02d5e5c6539b66de96a397d9f451563f5f27da263e0e",
                "md5": "b4093d0031d75c70948d4c411072983d",
                "sha256": "07ffa0e272ed01c876cbb1ba7edfcf33b8a34b2b791826b9c08b03be829a528f"
            },
            "downloads": -1,
            "filename": "flet_toast-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b4093d0031d75c70948d4c411072983d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 6811,
            "upload_time": "2024-08-27T22:21:49",
            "upload_time_iso_8601": "2024-08-27T22:21:49.690956Z",
            "url": "https://files.pythonhosted.org/packages/4e/e1/caf206079e92ffaf02d5e5c6539b66de96a397d9f451563f5f27da263e0e/flet_toast-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-27 22:21:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "webtechmoz",
    "github_project": "flet-toast",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "flet-toast"
}
        
Elapsed time: 2.52965s