-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Add spanish translation for /tutorial #53
Open
rafnixg
wants to merge
8
commits into
jowilf:main
Choose a base branch
from
rafnixg:docs-es
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+156
−123
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5e9153c
ADD: getting-started
rafnixg 2f5cad9
ADD: validations
rafnixg 3f89148
ADD:configurations
rafnixg d11fdb0
ADD: authentication
rafnixg a7eebfa
ADD: files
rafnixg 3cd002a
ADD: batch actions
rafnixg 6c2cee1
ADD: multiple-admin
rafnixg 67ad65c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Acciones por lotes | ||
|
||
De forma predeterminada, para actualizar un objeto, debe seleccionarlo en la página de lista y actualizarlo. Esto funciona bien para la mayoría de casos de uso. Sin embargo, si necesita realizar el mismo cambio en muchos objetos a la vez, este flujo de trabajo puede resultar bastante tedioso. | ||
|
||
En estos casos, puede escribir una *acción por lotes personalizada* para actualizar de forma masiva muchos objetos a la vez. | ||
|
||
!!! nota | ||
*starlette-admin* agrega por defecto una acción para eliminar muchos objetos a la vez | ||
|
||
Para agregar otras acciones por lotes a su [ModelView][starlette_admin.views.BaseModelView], además de la acción de eliminación predeterminada, puede definir una que implementa la lógica deseada y la envuelve con el decorador [@action][starlette_admin.actions.action] (muy inspirado en Flask-Admin). | ||
|
||
## Ejemplo | ||
```python | ||
from typing import List, Any | ||
|
||
from starlette.requests import Request | ||
|
||
from starlette_admin import action | ||
from starlette_admin.contrib.sqla import ModelView | ||
from starlette_admin.exceptions import ActionFailed | ||
|
||
|
||
class ArticleView(ModelView): | ||
actions = ["make_published", "delete"] # `delete` function is added by default | ||
|
||
@action( | ||
name="make_published", | ||
text="Mark selected articles as published", | ||
confirmation="Are you sure you want to mark selected articles as published ?", | ||
submit_btn_text="Yes, proceed", | ||
submit_btn_class="btn-success", | ||
) | ||
async def make_published_action(self, request: Request, pks: List[Any]) -> str: | ||
# Write your logic here | ||
if ...: | ||
# Display meaningfully error | ||
raise ActionFailed("Sorry, We can't proceed this action now.") | ||
# Display successfully message | ||
return "{} articles were successfully marked as published".format(len(pks)) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
# ModelView Configurations | ||
# Configuraciones de ModelView | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
Multiple options are available to customize your ModelView. For a complete list, have a look at the API documentation for | ||
[BaseModelView()][starlette_admin.views.BaseModelView]. Here are some of the most commonly used options: | ||
Hay múltiples opciones disponibles para personalizar su ModelView. Para obtener una lista completa, consulte la documentación de la API para [BaseModelView()][starlette_admin.views.BaseModelView]. Estas son algunas de las opciones más utilizadas: | ||
|
||
## Fields | ||
## Campos | ||
|
||
Use `fields` property to customize which fields to include in admin view. | ||
Use la propiedad `fields` para personalizar qué campos incluir en la vista de administración. | ||
|
||
```Python hl_lines="21" | ||
from sqlalchemy import JSON, Column, Integer, String, Text, create_engine | ||
|
@@ -38,45 +37,45 @@ admin.add_view(PostView(Post, icon="fa fa-blog")) | |
admin.mount_to(app) | ||
``` | ||
|
||
## Exclusions | ||
## Exclusiones | ||
|
||
There are several options to help you exclude some fields from certain part of admin interface. | ||
Hay varias opciones para ayudarlo a excluir algunos campos de cierta parte de la interfaz de administración. | ||
|
||
The options are: | ||
Las opciones son: | ||
|
||
* `exclude_fields_from_list`: List of fields to exclude in List page. | ||
* `exclude_fields_from_detail`: List of fields to exclude in Detail page. | ||
* `exclude_fields_from_create`: List of fields to exclude from creation page. | ||
* `exclude_fields_from_edit`: List of fields to exclude from editing page. | ||
* `exclude_fields_from_list`: Lista de campos para excluir en la página Lista. | ||
* `exclude_fields_from_detail`: Lista de campos para excluir en la página de Detalles. | ||
* `exclude_fields_from_create`: Lista de campos para excluir de la página de Creación. | ||
* `exclude_fields_from_edit`: Lista de campos para excluir de la página de Edición. | ||
|
||
```Python | ||
class PostView(ModelView): | ||
exclude_fields_from_list = [Post.content, Post.tags] | ||
``` | ||
|
||
## Searching & Sorting | ||
## Búsqueda y clasificación | ||
|
||
Two options are available to specify which fields can be sorted or searched. | ||
Hay dos opciones disponibles para especificar qué campos se pueden ordenar o buscar. | ||
|
||
* `searchable_fields` for list of searchable fields | ||
* `sortable_fields` for list of orderable fields | ||
* `searchable_fields` para la lista de campos de búsqueda | ||
* `sortable_fields` para la lista de campos ordenables | ||
|
||
!!! Usage | ||
!!! Uso | ||
```Python | ||
class PostView(ModelView): | ||
sortable_fields = [Post.id, "title"] | ||
searchable_fields = [Post.id, Post.title, "tags"] | ||
``` | ||
|
||
## Exporting | ||
## Exportando | ||
|
||
You can export your data from list page. The export options can be set per model and includes the following options: | ||
Puede exportar sus datos desde la página de lista. Las opciones de exportación se pueden configurar por modelo e incluyen las siguientes opciones: | ||
|
||
* `export_fields`: List of fields to include in exports. | ||
* `export_types`: A list of available export filetypes. Available | ||
exports are `['csv', 'excel', 'pdf', 'print']`. By default, All of them are activated by default. | ||
* `export_fields`: Lista de campos a incluir en las exportaciones. | ||
* `export_types`: una lista de tipos de archivo de exportación disponibles. | ||
Las exportaciones disponibles son `['csv', 'excel', 'pdf', 'print']`. Por defecto, todos ellos están activos por defecto. | ||
|
||
!!! Example | ||
!!! Ejemplo | ||
```Python | ||
from starlette_admin import ExportType | ||
|
||
|
@@ -85,32 +84,32 @@ exports are `['csv', 'excel', 'pdf', 'print']`. By default, All of them are acti | |
export_types = [ExportType.CSV, ExportType.EXCEL] | ||
``` | ||
|
||
## Pagination | ||
## Paginación | ||
|
||
The pagination options in the list page can be configured. The available options are: | ||
Las opciones de paginación en la página de lista se pueden configurar. Las opciones disponibles son: | ||
|
||
* `page_size`: Default number of items to display in List page pagination. | ||
Default value is set to `10`. | ||
* `page_size_options`: Pagination choices displayed in List page. Default value is set to `[10, 25, 50, 100]`. | ||
Use `-1`to display All | ||
* `page_size`: número predeterminado de elementos para mostrar en la paginación de la página de lista. | ||
El valor predeterminado se establece en `10`. | ||
* `page_size_options`: opciones de paginación que se muestran en la página de lista. El valor predeterminado se establece en `[10, 25, 50, 100]`. | ||
Use `-1` para mostrar Todo | ||
|
||
|
||
!!! Example | ||
!!! Ejemplo | ||
```Python | ||
class PostView(ModelView): | ||
page_size = 5 | ||
page_size_options = [5, 10, 25, 50, -1] | ||
``` | ||
|
||
## Templates | ||
The template files are built using Jinja2 and can be completely overridden in the configurations. The pages available are: | ||
## Plantillas | ||
Los archivos de plantilla se crean con Jinja2 y se pueden reescribir por completo en las configuraciones. Las páginas disponibles son: | ||
|
||
* `list_template`: List view template. Default is `list.html`. | ||
* `detail_template`: Details view template. Default is `detail.html`. | ||
* `create_template`: Edit view template. Default is `create.html`. | ||
* `edit_template`: Edit view template. Default is `edit.html`. | ||
* `list_template`: plantilla de vista de lista. El valor predeterminado es `list.html`. | ||
* `detail_template`: Plantilla de vista de detalles. El valor predeterminado es `detail.html`. | ||
* `create_template`: Plantilla de vista de edición. El valor predeterminado es `create.html`. | ||
* `edit_template`: Plantilla de vista de edición. El valor predeterminado es `edit.html`. | ||
|
||
!!! Example | ||
!!! Ejemplo | ||
```Python | ||
class PostView(ModelView): | ||
detail_template = "post_detail.html" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is out of date