> For the complete documentation index, see [llms.txt](https://sunshine-team.gitbook.io/sunshineadminbundle/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sunshine-team.gitbook.io/sunshineadminbundle/master.md).

# Sunshine Admin Bundle

## Documentation

This documentation is available with a lot of features on : \
<https://sunshine-team.gitbook.io/sunshineadminbundle/>

### Requierements

| PHP     | 7.0 or later                   |
| ------- | ------------------------------ |
| Symfony | 3.4 or later. SF4 recommended. |

The bundle provides two different level :

* **Entities management** : Very simple to setup, it makes possible to handle CRUD actions very easily.
* **Pages** and **widgets** management : Makes possible for user to go a step further and customize the backoffice application.

### Let's play

* [Setup in your project](/sunshineadminbundle/setup.md)
* [Theme Configuration](/sunshineadminbundle/theme-configuration.md)

### Entities Management

* [YAML Entity description](/sunshineadminbundle/yaml-entity-configuration.md)
* [Field types and overrides](/sunshineadminbundle/field-type-and-overrides.md)
* [Entity Relations](/sunshineadminbundle/entity-relations.md)

### Pages, Widget and menu

* [Menu Configuration](/sunshineadminbundle/menu-configuration.md)
  * [Type : section](https://sunshine-team.gitbook.io/sunshineadminbundle/pages/-LAYF5qu7JGl3YuwMhOw#type-:-section)
  * [Type : submenu](https://sunshine-team.gitbook.io/sunshineadminbundle/pages/-LAYF5qu7JGl3YuwMhOw#type-:-submenu)
  * [Type : list](https://sunshine-team.gitbook.io/sunshineadminbundle/pages/-LAYF5qu7JGl3YuwMhOw#type-:-sunshine-list)
  * [Type : page](/sunshineadminbundle/menu-configuration.md)
  * [Type : route](https://sunshine-team.gitbook.io/sunshineadminbundle/pages/-LAYF5qu7JGl3YuwMhOw#type-:-route)
  * [Type : external page](https://sunshine-team.gitbook.io/sunshineadminbundle/pages/-LAYF5qu7JGl3YuwMhOw#type-:-external-page)
  * [Roles & Permissions](/sunshineadminbundle/menu-configuration.md#roles-and-permissions-configuration)
* [Theme configuration](/sunshineadminbundle/theme-configuration.md)
* [Page configuration](/sunshineadminbundle/creating-a-page.md)
  * [YAML Configuration](/sunshineadminbundle/creating-a-page.md#yaml-definition)
  * [Conventions](/sunshineadminbundle/creating-a-page.md#conventions)
  * [Title & Description ](/sunshineadminbundle/creating-a-page.md#title-and-description)
  * [Using widgets](/sunshineadminbundle/creating-a-page.md#using-widgets)
* [Widgets](/sunshineadminbundle/untitled.md)
  * [YAML Configuration](/sunshineadminbundle/untitled.md#yaml-configuration)
  * [Service class creation](/sunshineadminbundle/untitled.md#service-class-creation)
  * [The Twig view](/sunshineadminbundle/untitled.md#view-creation)
  * [MessageBag Bus](/sunshineadminbundle/untitled.md#messagebag-send-informations-to-widget)
  * [Using forms](/sunshineadminbundle/untitled.md#forms-inside-a-widget)
  * [Redirect and Forward response](/sunshineadminbundle/untitled.md#redirect-to-current-route)
* [Creation of a new Page with widgets](/sunshineadminbundle/creating-a-page.md)
  * [YAML Configuration](/sunshineadminbundle/creating-a-page.md#yaml-definition)
  * [Using Widgets](/sunshineadminbundle/creating-a-page.md#using-widgets)
* [Creating Widgets](/sunshineadminbundle/untitled.md)
  * [YAML Configuration](/sunshineadminbundle/untitled.md#yaml-configuration)
  * [Service class creation](/sunshineadminbundle/untitled.md#service-class-creation)
  * [The View](/sunshineadminbundle/untitled.md#view-creation)
  * [The messageBag](/sunshineadminbundle/untitled.md#messagebag-send-informations-to-widget)
  * [Using Forms in widgets](/sunshineadminbundle/untitled.md#forms-inside-a-widget)
  * [Redirect to current route](/sunshineadminbundle/untitled.md#redirect-to-current-route)
  * [Using services in widgets](/sunshineadminbundle/untitled.md#how-to-inject-services-in-widget-service)

### Crud Widget

* [Generic Widget : List](/sunshineadminbundle/generic-widgets.md)
  * [YAML Configuration](/sunshineadminbundle/generic-widgets.md#yaml-configuration)
  * [Configuration Inheritance & Overrides](/sunshineadminbundle/generic-widgets.md#configuration-inheritance)
  * [Preset values for Filters](/sunshineadminbundle/generic-widgets.md#override-list-and-filters)
  * [Add/Remove columns or filters](/sunshineadminbundle/generic-widgets.md#configuration-inheritance)
  * [Configure a datasource for a filter](/sunshineadminbundle/filtering-custom-values-in-select2-lists.md)

### Security and Roles

* Enabling Authentication
* [Filtering by user role](/sunshineadminbundle/roles-and-permissions.md)
  * [Widgets](/sunshineadminbundle/roles-and-permissions.md#widget)
  * [Menu](/sunshineadminbundle/roles-and-permissions.md#menu)
  * [Pages](/sunshineadminbundle/roles-and-permissions.md#page)

### Filtering List

* [Default filter value](/sunshineadminbundle/filtering-default-values.md)
* [Multiple filter values](/sunshineadminbundle/filtering-options-multiple.md)

### Ordered list

* How to order lists