A widget can be understood as a module in the administration panel. Each widget implements a part of an e-commerce administration functionality. Most important are:
- models for definition of database structure (and CRUD functionality)
- actions for non-CRUD functionality (reports, exports, imports, ...)
- API methods for using in plugins
- events for implementing callbacks in plugins
Table below summarizes the list of all available widgets in Surikata.io package in alphabetical order.
Click on a widget to learn about its models, actions, exceptions, events, etc.
|Customers||General purpose addressbook|
|Finances||Invoices and economics|
|Orders||Management of orders|
|Overview||The "welcome" widget shown after login|
|Plugins||Your plugins will appear here|
|Prices||Product prices, discounts and margins|
|Products||The product catalog|
|Settings||General settings your website|
Table: List of available widgets, in alphabetical order
Modify default widget behaviour
Widgets are implemented directly in the core of Surikata.io platform. However, if you are a plugin programmer, you can create callbacks on various events dispatched by the widget. E.g. the the Customer widget exposes the onCustomerDetailSidebarButtons event in which you can extend the detail view of a customer. Refer to the documentation of each widget for the list of their events.
Create your own widget
All widgets are located in the src/Widgets/ folder. If you want to create a new widget, you should have enough knowledge in ADIOS framework programming. This would also expect modification of the core which is the most critical part of contribution. However feel free to do that and let us know your success.