diff --git a/better-docs b/better-docs index f9318f24..419d4f6a 160000 --- a/better-docs +++ b/better-docs @@ -1 +1 @@ -Subproject commit f9318f24e2e23979d46addd6dbf90c3d05e2eb53 +Subproject commit 419d4f6aef54591d54dfef034d9d705fe72dd304 diff --git a/docs/Action.html b/docs/Action.html index 5a8e0100..fa63f41f 100644 --- a/docs/Action.html +++ b/docs/Action.html @@ -343,7 +343,7 @@
Type of an action - could be either resource, record or bulk.
+ Type of an action - could be either _resource_, _record_ or _bulk_.
When you define a new action - it is required.
After action hook. When it is given - it is performed on the returned, -by handler function response.
+ After action hook. When it is given - it is performed on the returned, +by handler function response.
You can use it to (just an idea)
Before action hook. When it is given - it is performed before the Action#handler -method.
+ Before action hook. When it is given - it is performed before the Action#handler +method.
Example of hashing password before creating it:
actions: {
new: {
@@ -652,8 +652,8 @@
- Component which will be used to render the action. To pass the component
-use AdminJS.bundle method.
+ Component which will be used to render the action. To pass the component
+use AdminJS.bundle method.
Action components accepts ActionProps and are rendered by the
BaseActionComponent
When component is set to false then action doesn't have it's own view.
@@ -743,8 +743,8 @@
- The max width of action HTML container.
-You can put here an actual size in px or an array of widths, where different values
+ The max width of action HTML container.
+
You can put here an actual size in px or an array of widths, where different values
will be responsible for different breakpoints.
It is directly passed to action's wrapping Box component, to its width property.
Examples
@@ -836,8 +836,8 @@
- Any custom properties you want to pass down to ActionJSON. They have to
-be stringified.
+ Any custom properties you want to pass down to ActionJSON. They have to
+be stringified.
@@ -916,7 +916,7 @@
- guard message - user will have to confirm it before executing an action.
+ guard message - user will have to confirm it before executing an action.
new AdminJS({ resources: [{
resource: Car,
options: { actions: {
@@ -1011,7 +1011,7 @@
- handler function which will be invoked by either:
+ handler function which will be invoked by either:
- ApiController#resourceAction
- ApiController#recordAction
@@ -1114,8 +1114,8 @@
- Indicates if Action Header should be hidden.
-Action header consist of:
+ Indicates if Action Header should be hidden.
+Action header consist of:
- breadcrumbs
- action buttons
@@ -1199,8 +1199,8 @@
- icon name for the action. Take a look Icon component,
-because what you put here is passed down to it.
+ icon name for the action. Take a look Icon component,
+because what you put here is passed down to it.
new AdminJS({ resources: [{
resource: Car,
options: { actions: { edit: { icon: 'Add' } } },
@@ -1287,8 +1287,8 @@
- Indicates if the action can be invoked for given invocation context.
-You can pass a boolean or function of type IsFunction, which
+ Indicates if the action can be invoked for given invocation context.
+
You can pass a boolean or function of type IsFunction, which
takes ActionContext as an argument.
You can use it as a carrier between the hooks.
Example for isVisible function which allows the user to edit cars which belongs only
@@ -1395,8 +1395,8 @@
- indicates if action should be visible for given invocation context.
-It also can be a simple boolean value.
+ indicates if action should be visible for given invocation context.
+
It also can be a simple boolean value.
True by default.
The most common example of usage is to hide resources from the UI.
So let say we have 2 resources User and Cars:
@@ -1508,7 +1508,7 @@
- Definition for the layout. Works with the edit and show actions.
+ Definition for the layout. Works with the edit and show actions.
With the help of LayoutElement you can put all the properties to whatever
layout you like, without knowing React.
This is an example of defining a layout
@@ -1618,8 +1618,8 @@
- Name of an action which is its uniq key.
-If you use one of list, search, edit, new, show, delete or
+ Name of an action which is its uniq key.
+
If you use one of list, search, edit, new, show, delete or
bulkDelete you override existing actions.
For all other keys you create a new action.
@@ -1700,8 +1700,8 @@
- Action can be nested. If you give here another action name - it will be nested under it.
-If parent action doesn't exists - it will be nested under name in the parent.
+ Action can be nested. If you give here another action name - it will be nested under it.
+If parent action doesn't exists - it will be nested under name in the parent.
@@ -1780,7 +1780,7 @@
- if filter should be visible on the sidebar. Only for resource actions
+ if filter should be visible on the sidebar. Only for _resource_ actions
Example of creating new resource action with filter
new AdminJS({ resources: [{
resource: Car,
@@ -1870,7 +1870,7 @@
- Indicates if given action should be seen in a drawer or in a full screen. Default to false
+ Indicates if given action should be seen in a drawer or in a full screen. Default to false
@@ -1949,7 +1949,7 @@
- Defines the variant of the action. based on that it will receive given color.
+ Defines the variant of the action. based on that it will receive given color.
@@ -2037,8 +2037,8 @@
- Execution context for an action. It is passed to the Action#handler,
-Action#before and Action#after functions.
+ Execution context for an action. It is passed to the Action#handler,
+Action#before and Action#after functions.
Apart from the properties defined below it also extends TranslateFunctions.
So you can use i.e. context.translateMessage(...) and others...
@@ -2415,8 +2415,8 @@
- Type of a handler function. It has to return response compatible
-with ActionResponse, BulkActionResponse or RecordActionResponse
+ Type of a handler function. It has to return response compatible
+with ActionResponse, BulkActionResponse or RecordActionResponse
@@ -2642,7 +2642,7 @@
- ActionRequest
+ ActionRequest
@@ -3055,7 +3055,7 @@
- Base response for all actions
+ Base response for all actions
@@ -3253,7 +3253,7 @@
- Type of an after hook action.
+ Type of an after hook action.
@@ -3455,8 +3455,8 @@
- Before action hook. When it is given - it is performed before the ActionHandler
-method.
+ Before action hook. When it is given - it is performed before the ActionHandler
+method.
@@ -3657,7 +3657,7 @@
- Required response of a Record action. Extends ActionResponse
+ Required response of a Record action. Extends ActionResponse
@@ -3781,7 +3781,7 @@
- Defines the type of Action#isAccessible and Action#isVisible functions
+ Defines the type of Action#isAccessible and Action#isVisible functions
@@ -4009,7 +4009,7 @@
- Function returning Array used by Action#layout
+ Function returning Array used by Action#layout
@@ -4197,7 +4197,7 @@
- Required response of a Record action. Extends ActionResponse
+ Required response of a Record action. Extends ActionResponse
diff --git a/docs/ActionButton.html b/docs/ActionButton.html
index 79bf9442..2dd3aa4f 100644
--- a/docs/ActionButton.html
+++ b/docs/ActionButton.html
@@ -222,7 +222,7 @@
- Renders Button which redirects to given action
+ Renders Button which redirects to given action
Usage
import { ActionButton } from 'adminjs'
diff --git a/docs/ActionDecorator.html b/docs/ActionDecorator.html
index 1def0e16..e4632f40 100644
--- a/docs/ActionDecorator.html
+++ b/docs/ActionDecorator.html
@@ -477,7 +477,7 @@
- Original action object
+ Original action object
@@ -558,7 +558,7 @@
- Indicates if user can invoke given action
+ Indicates if user can invoke given action
@@ -756,7 +756,7 @@
- Original handler wrapped with the hook before and after methods.
+ Original handler wrapped with the hook `before` and `after` methods.
@@ -981,7 +981,7 @@
- Invokes after action hooks if there are any
+ Invokes after action hooks if there are any
@@ -1206,7 +1206,7 @@
- Invokes before action hooks if there are any
+ Invokes before action hooks if there are any
@@ -1406,7 +1406,7 @@
- Invokes action handler if there is any
+ Invokes action handler if there is any
@@ -1627,7 +1627,7 @@
- Is action accessible
+ Is action accessible
@@ -1845,7 +1845,7 @@
- Returns true when action can be performed on selected records
+ Returns true when action can be performed on selected records
@@ -1965,7 +1965,7 @@
- Returns true when action can be performed on a record
+ Returns true when action can be performed on a record
@@ -2085,7 +2085,7 @@
- Returns true when action can be performed on an entire resource
+ Returns true when action can be performed on an entire resource
@@ -2205,7 +2205,7 @@
- Is action visible in the UI
+ Is action visible in the UI
@@ -2423,7 +2423,7 @@
- Serializes action to JSON format
+ Serializes action to JSON format
diff --git a/docs/ActionHeader.html b/docs/ActionHeader.html
index e2bf5b34..69e1dc58 100644
--- a/docs/ActionHeader.html
+++ b/docs/ActionHeader.html
@@ -222,7 +222,7 @@
- Header of an action. It renders Action name with buttons for all the actions.
+ Header of an action. It renders Action name with buttons for all the actions.
Usage
import { ActionHeader } from 'adminjs'
diff --git a/docs/ActionJSON.html b/docs/ActionJSON.html
index 71f40b58..5c76cd1d 100644
--- a/docs/ActionJSON.html
+++ b/docs/ActionJSON.html
@@ -196,7 +196,7 @@ ActionJSON
- JSON representation of an Action
+ JSON representation of an Action
@@ -301,7 +301,7 @@
- Type of an action
+ Type of an action
@@ -386,8 +386,8 @@
- Action component. When set to false action will be invoked immediately after clicking it,
-to put in another words: there wont be an action view
+ Action component. When set to false action will be invoked immediately after clicking it,
+to put in another words: there wont be an action view
@@ -470,7 +470,7 @@
- containerWidth passed from the action setup.
+ containerWidth passed from the action setup.
@@ -547,7 +547,7 @@
- Any custom options passed from the Action configuration.
+ Any custom options passed from the Action configuration.
@@ -626,7 +626,7 @@
- Guarding message which should be presented in alert() after clicking the action button
+ Guarding message which should be presented in `alert()` after clicking the action button
@@ -703,7 +703,7 @@
- Indicates if action has action handler defined
+ Indicates if action has action handler defined
@@ -780,7 +780,7 @@
- Whether given action have an action header
+ Whether given action have an action header
@@ -859,7 +859,7 @@
- Action icon
+ Action icon
@@ -936,7 +936,7 @@
- Action label - visible on the frontend
+ Action label - visible on the frontend
@@ -1016,7 +1016,7 @@
- Parsed layout passed in Action#layout
+ Parsed layout passed in Action#layout
@@ -1093,7 +1093,7 @@
- Unique action name
+ Unique action name
@@ -1173,7 +1173,7 @@
- If action is nested
+ If action is nested
@@ -1250,7 +1250,7 @@
- Id of a resource to which given action belongs.
+ Id of a resource to which given action belongs.
@@ -1327,7 +1327,7 @@
- If action should have a filter (for resource actions)
+ If action should have a filter (for resource actions)
@@ -1404,7 +1404,7 @@
- Whether given action should be seen in a drawer
+ Whether given action should be seen in a drawer
@@ -1481,7 +1481,7 @@
- action variant
+ action variant
@@ -1569,7 +1569,7 @@
- It is generated from Array.<LayoutElement> passed in Action#layout
+ It is generated from Array.<LayoutElement> passed in Action#layout
diff --git a/docs/AdminJS.html b/docs/AdminJS.html
index bd26861d..719026dd 100644
--- a/docs/AdminJS.html
+++ b/docs/AdminJS.html
@@ -420,8 +420,8 @@
- List of all default actions. If you want to change the behavior for all actions like:
-list, edit, show, delete and bulkDelete you can do this here.
+ List of all default actions. If you want to change the behavior for all actions like:
+list, edit, show, delete and bulkDelete you can do this here.
@@ -512,7 +512,7 @@
- AdminJS version
+ AdminJS version
@@ -581,8 +581,8 @@
- List of all default actions. If you want to change the behavior for all actions like:
-list, edit, show, delete and bulkDelete you can do this here.
+ List of all default actions. If you want to change the behavior for all actions like:
+list, edit, show, delete and bulkDelete you can do this here.
@@ -669,7 +669,7 @@
- Options given by a user
+ Options given by a user
@@ -746,8 +746,8 @@
- List of all resources available for the AdminJS.
-They can be fetched with the AdminJS#findResource method
+ List of all resources available for the AdminJS.
+They can be fetched with the AdminJS#findResource method
@@ -816,7 +816,7 @@
- AdminJS version
+ AdminJS version
@@ -901,8 +901,8 @@
- Requires given .jsx/.tsx file, that it can be bundled to the frontend.
-It will be available under AdminJS.UserComponents[componentId].
+ Requires given `.jsx/.tsx` file, that it can be bundled to the frontend.
+It will be available under AdminJS.UserComponents[componentId].
@@ -1145,7 +1145,7 @@
- Registers various database adapters written for AdminJS.
+ Registers various database adapters written for AdminJS.
@@ -1374,7 +1374,7 @@
- Returns resource base on its ID
+ Returns resource base on its ID
@@ -1580,8 +1580,8 @@
- Initializes AdminJS instance in production. This function should be called by
-all external plugins.
+ Initializes AdminJS instance in production. This function should be called by
+all external plugins.
@@ -1705,8 +1705,8 @@
- Renders an entire login page with email and password fields
-using Renderer.
+ Renders an entire login page with email and password fields
+using Renderer.
Used by external plugins
@@ -1960,8 +1960,8 @@
- Resolve babel config file path,
-and load configuration to this.options.bundler.babelConfig.
+ Resolve babel config file path,
+and load configuration to this.options.bundler.babelConfig.
@@ -2085,8 +2085,8 @@
- Watches for local changes in files imported via AdminJS.bundle.
-It doesn't work on production environment.
+ Watches for local changes in files imported via AdminJS.bundle.
+It doesn't work on production environment.
@@ -2220,7 +2220,7 @@
- Currently logged in admin.
+ Currently logged in admin.
Usage with TypeScript
import { CurrentAdmin } from 'adminjs'
@@ -2482,8 +2482,8 @@
- Name of the components which can be overridden by AdminJS.bundle. It currently following
-components can be override:
+ Name of the components which can be overridden by AdminJS.bundle. It currently following
+components can be override:
- LoggedIn
- NoRecords
@@ -2568,7 +2568,7 @@
- File uploaded via FormData to the backend.
+ File uploaded via FormData to the backend.
diff --git a/docs/AdminJSOptions.html b/docs/AdminJSOptions.html
index 5e9c9eba..108a50db 100644
--- a/docs/AdminJSOptions.html
+++ b/docs/AdminJSOptions.html
@@ -196,7 +196,7 @@ AdminJSOptions
- AdminJSOptions
+ AdminJSOptions
This is the heart of entire AdminJS - all options resides here.
Usage with regular javascript
const AdminJS = require('adminjs')
@@ -324,7 +324,7 @@
- Custom assets you want to pass to AdminJS
+ Custom assets you want to pass to AdminJS
@@ -403,7 +403,7 @@
- Indicates is bundled by AdminJS files like:
+ Indicates is bundled by AdminJS files like:
- components.bundle.js
- global.bundle.js
@@ -526,7 +526,7 @@
- Options which are related to the branding.
+ Options which are related to the branding.
@@ -605,7 +605,7 @@
- rollup bundle options;
+ rollup bundle options;
@@ -684,7 +684,7 @@
- Option to modify the dashboard
+ Option to modify the dashboard
@@ -856,7 +856,7 @@
- Array of all Databases which are supported by AdminJS via adapters
+ Array of all Databases which are supported by AdminJS via adapters
@@ -935,7 +935,7 @@
- Environmental variables passed to the frontend.
+ Environmental variables passed to the frontend.
So let say you want to pass some GOOGLE_MAP_API_TOKEN to the frontend.
You can do this by adding it here:
new AdminJS({env: {
@@ -1023,7 +1023,7 @@
- Translation file. Change it in order to:
+ Translation file. Change it in order to:
- localize admin panel
- change any arbitrary text in the UI
@@ -1148,7 +1148,7 @@
- url to a login page, default to /admin/login
+ url to a login page, default to `/admin/login`
@@ -1227,7 +1227,7 @@
- url to a logout action, default to /admin/logout
+ url to a logout action, default to `/admin/logout`
@@ -1306,7 +1306,7 @@
- List of custom pages which will be visible below all resources
+ List of custom pages which will be visible below all resources
@@ -1406,8 +1406,8 @@
- Array of all Resources which are supported by AdminJS via adapters.
-You can pass either resource or resource with an options and thus modify it.
+ Array of all Resources which are supported by AdminJS via adapters.
+You can pass either resource or resource with an options and thus modify it.
@@ -1591,7 +1591,7 @@
- path, under which, AdminJS will be available. Default to /admin
+ path, under which, AdminJS will be available. Default to `/admin`
@@ -1670,7 +1670,7 @@
- Flag which indicates if version number should be visible on the UI
+ Flag which indicates if version number should be visible on the UI
@@ -1758,7 +1758,7 @@
- Object describing regular page in AdminJS
+ Object describing regular page in AdminJS
@@ -2123,7 +2123,7 @@
@@ -2314,7 +2314,7 @@
- Branding Options
+ Branding Options
You can use them to change how AdminJS looks. For instance to change name and
colors (dark theme) run:
new AdminJS({
@@ -2584,7 +2584,7 @@
- Branding Options Function
+ Branding Options Function
function returning BrandingOptions.
@@ -2776,7 +2776,7 @@
- Bundle options
+ Bundle options
@@ -2924,7 +2924,7 @@
- Function taking ResourceOptions and merging it with all other options
+ Function taking ResourceOptions and merging it with all other options
@@ -3100,7 +3100,7 @@
- Locale object passed to AdminJSOptions and stored in the application
+ Locale object passed to AdminJSOptions and stored in the application
@@ -3252,8 +3252,8 @@
- Contains all the translations for given language. Everything is divided to
-sections/blocks like actions, properties, buttons, labels and messages,
+ Contains all the translations for given language. Everything is divided to
+
sections/blocks like actions, properties, buttons, labels and messages,
but also the same sections can can be nested under 'resources' property.
This allows you to define translations either for entire UI or for a specific resource.
Take a look at this example:
@@ -3754,7 +3754,7 @@
- Context object passed to a PageHandler
+ Context object passed to a PageHandler
@@ -3946,7 +3946,7 @@
- Function which is invoked when user enters given AdminPage
+ Function which is invoked when user enters given AdminPage
@@ -4149,7 +4149,7 @@
- Default way of passing Options with a Resource
+ Default way of passing Options with a Resource
@@ -4346,7 +4346,7 @@
- Version Props
+ Version Props
diff --git a/docs/ApiClient.html b/docs/ApiClient.html
index 7a0d4807..eed0da55 100644
--- a/docs/ApiClient.html
+++ b/docs/ApiClient.html
@@ -337,7 +337,7 @@
@@ -514,7 +514,7 @@
- Invokes dashboard handler.
+ Invokes dashboard handler.
@@ -692,7 +692,7 @@
- Invokes handler function of given page and returns its response.
+ Invokes handler function of given page and returns its response.
@@ -870,7 +870,7 @@
@@ -1047,7 +1047,7 @@
@@ -1224,7 +1224,7 @@
- Search by query string for records in a given resource.
+ Search by query string for records in a given resource.
@@ -1458,7 +1458,7 @@
- Extends AxiosRequestConfig
+ Extends AxiosRequestConfig
@@ -1587,7 +1587,7 @@
- Type of an axios request
+ Type of an axios request
@@ -1671,7 +1671,7 @@
- Extends ActionAPIParams
+ Extends ActionAPIParams
@@ -1807,7 +1807,7 @@
- Extends AxiosRequestConfig
+ Extends AxiosRequestConfig
@@ -1959,7 +1959,7 @@
- Extends ActionAPIParams
+ Extends ActionAPIParams
@@ -2088,7 +2088,7 @@
- Extends ActionAPIParams
+ Extends ActionAPIParams
diff --git a/docs/ApiController.html b/docs/ApiController.html
index 3528cd8e..cc2832aa 100644
--- a/docs/ApiController.html
+++ b/docs/ApiController.html
@@ -377,8 +377,8 @@
- Performs a customized bulk action.
-To call it use ApiClient#bulkAction method.
+ Performs a customized bulk action.
+To call it use ApiClient#bulkAction method.
Handler function responsible for a .../api/resources/{resourceId}/bulk/{action}?recordIds={recordIds}
@@ -609,8 +609,8 @@
- Gets optional data needed by the dashboard.
-To call it use ApiClient#getDashboard method.
+ Gets optional data needed by the dashboard.
+To call it use ApiClient#getDashboard method.
Handler function responsible for a .../api/dashboard
@@ -813,8 +813,8 @@
- Gets optional data needed by the page.
-To call it use ApiClient#getPage method.
+ Gets optional data needed by the page.
+To call it use ApiClient#getPage method.
Handler function responsible for a .../api/pages/{pageName}
@@ -1017,8 +1017,8 @@
- Performs a customized record action.
-To call it use ApiClient#recordAction method.
+ Performs a customized record action.
+To call it use ApiClient#recordAction method.
Handler function responsible for a .../api/resources/{resourceId}/records/{recordId}/{action}
@@ -1248,8 +1248,8 @@
- Performs a customized resource action.
-To call it use ApiClient#resourceAction method.
+ Performs a customized resource action.
+To call it use ApiClient#resourceAction method.
Handler function responsible for a .../api/resources/{resourceId}/actions/{action}
@@ -1452,7 +1452,7 @@
- Search records by query string.
+ Search records by query string.
Handler function responsible for a .../api/resources/{resourceId}/search/{query} route
diff --git a/docs/BaseActionComponent.html b/docs/BaseActionComponent.html
index 8e498fa0..b9de2ea7 100644
--- a/docs/BaseActionComponent.html
+++ b/docs/BaseActionComponent.html
@@ -222,7 +222,7 @@
- Component which renders all the default and custom actions for both the Resource and the Record.
+ Component which renders all the default and custom actions for both the Resource and the Record.
It passes all props down to the actual Action component.
Example of creating your own actions:
// AdminJS options
@@ -391,7 +391,7 @@
- Props which are passed to all action components
+ Props which are passed to all action components
diff --git a/docs/BaseDatabase.html b/docs/BaseDatabase.html
index 6fe58684..7ccb4990 100644
--- a/docs/BaseDatabase.html
+++ b/docs/BaseDatabase.html
@@ -223,9 +223,9 @@
graph LR
- A[BaseDatabase] -->|has many| B(BaseResource)
- B --> |has many|C(BaseRecord)
- B --> |has many|D(BaseProperty)
+A[BaseDatabase] -->|has many| B(BaseResource)
+B --> |has many|C(BaseRecord)
+B --> |has many|D(BaseProperty)
@@ -351,7 +351,7 @@
- Checks if given adapter supports database provided by user
+ Checks if given adapter supports database provided by user
@@ -524,7 +524,7 @@
- returns array of all resources (collections/tables) in the database
+ returns array of all resources (collections/tables) in the database
diff --git a/docs/BaseProperty.html b/docs/BaseProperty.html
index ff948959..f6b150b0 100644
--- a/docs/BaseProperty.html
+++ b/docs/BaseProperty.html
@@ -576,8 +576,8 @@
- Returns all available values which field can accept. It is used in case of
-enums
+ Returns all available values which field can accept. It is used in case of
+enums
@@ -703,7 +703,7 @@
- Returns true when given property is an array
+ Returns true when given property is an array
@@ -823,8 +823,8 @@
- Returns true when given property has draggable elements.
-Only usable for array properties.
+ Returns true when given property has draggable elements.
+Only usable for array properties.
@@ -944,7 +944,7 @@
- Indicates if value of given property can be updated
+ Indicates if value of given property can be updated
@@ -1064,7 +1064,7 @@
- Returns true if given property is a uniq key in a table/collection
+ Returns true if given property is a uniq key in a table/collection
@@ -1184,7 +1184,7 @@
- Indicates if given property is required
+ Indicates if given property is required
@@ -1304,7 +1304,7 @@
- Indicates if given property can be sorted
+ Indicates if given property can be sorted
@@ -1424,7 +1424,7 @@
- Return true if given property should be treated as a Record Title.
+ Return true if given property should be treated as a Record Title.
@@ -1544,7 +1544,7 @@
- Indicates if given property should be visible
+ Indicates if given property should be visible
@@ -1664,7 +1664,7 @@
- Name of the property
+ Name of the property
@@ -1786,8 +1786,8 @@
- If property is a reference to a record of different resource
-it should contain BaseResource.id of this resource.
+ If property is a reference to a record of different resource
+it should contain BaseResource.id of this resource.
When property is responsible for the field: 'user_id' in SQL database
reference should be the name of the Resource which it refers to: Users
@@ -1912,7 +1912,7 @@
- In case of mixed type returns all nested properties.
+ In case of `mixed` type returns all nested properties.
@@ -2034,7 +2034,7 @@
- Return type of a property
+ Return type of a property
diff --git a/docs/BasePropertyComponent.html b/docs/BasePropertyComponent.html
index 38369bd8..5f6d227d 100644
--- a/docs/BasePropertyComponent.html
+++ b/docs/BasePropertyComponent.html
@@ -327,7 +327,7 @@
- Props which are passed to all your custom property components
+ Props which are passed to all your custom property components
Example
// AdminJSOptions
const AdminJS = require('adminjs')
@@ -647,7 +647,7 @@
- Props which are passed to all your custom property components in show
+ Props which are passed to all your custom property components in show
@@ -799,7 +799,7 @@
- Props which are passed to all your custom property components in filter
+ Props which are passed to all your custom property components in filter
@@ -1206,7 +1206,7 @@
- Props which are passed to all your custom property components in show
+ Props which are passed to all your custom property components in show
diff --git a/docs/BaseProvider.html b/docs/BaseProvider.html
index 940d5134..a421d8bb 100644
--- a/docs/BaseProvider.html
+++ b/docs/BaseProvider.html
@@ -400,7 +400,7 @@
- Bucket is a place where files should be stored. Usually it is a folder location
+ Bucket is a place where files should be stored. Usually it is a folder location
@@ -477,7 +477,7 @@
- Bucket is a place where files should be stored. Usually it is a folder location
+ Bucket is a place where files should be stored. Usually it is a folder location
@@ -546,8 +546,8 @@
- Name is used to verify if the object passed by UploadOptions#provider is
-this type. We cannot check typeof because there could be a different versions of
+ Name is used to verify if the object passed by UploadOptions#provider is
+
this type. We cannot check typeof because there could be a different versions of
npm package installed in a project.
@@ -625,8 +625,8 @@
- Name is used to verify if the object passed by UploadOptions#provider is
-this type. We cannot check typeof because there could be a different versions of
+ Name is used to verify if the object passed by UploadOptions#provider is
+
this type. We cannot check typeof because there could be a different versions of
npm package installed in a project.
@@ -714,7 +714,7 @@
- Deletes given file
+ Deletes given file
@@ -941,8 +941,8 @@
- Returns path for the file from where it can be downloaded. It is dynamic in case of
-time based paths: i.e. link valid in the next 24h
+ Returns path for the file from where it can be downloaded. It is dynamic in case of
+time based paths: i.e. link valid in the next 24h
@@ -1172,7 +1172,7 @@
- Uploads file to given bucket
+ Uploads file to given bucket
diff --git a/docs/BaseRecord.html b/docs/BaseRecord.html
index 9e833a5b..52d9123c 100644
--- a/docs/BaseRecord.html
+++ b/docs/BaseRecord.html
@@ -422,7 +422,7 @@
- Object containing all validation errors: this.errors[path] = 'errorMessage'
+ Object containing all validation errors: this.errors[path] = 'errorMessage'
@@ -499,7 +499,7 @@
- Object containing all validation errors: this.errors[path] = 'errorMessage'
+ Object containing all validation errors: this.errors[path] = 'errorMessage'
@@ -568,8 +568,8 @@
- Actual record data stored as a flatten object. You shouldn't access them directly - always
-with BaseRecord#get and BaseRecord#set property.
+ Actual record data stored as a flatten object. You shouldn't access them directly - always
+with BaseRecord#get and BaseRecord#set property.
@@ -646,8 +646,8 @@
- Actual record data stored as a flatten object. You shouldn't access them directly - always
-with BaseRecord#get and BaseRecord#set property.
+ Actual record data stored as a flatten object. You shouldn't access them directly - always
+with BaseRecord#get and BaseRecord#set property.
@@ -716,7 +716,7 @@
- Object containing all populated relations.
+ Object containing all populated relations.
@@ -793,7 +793,7 @@
- Object containing all populated relations.
+ Object containing all populated relations.
@@ -862,7 +862,7 @@
- Resource to which record belongs
+ Resource to which record belongs
@@ -939,7 +939,7 @@
- Resource to which record belongs
+ Resource to which record belongs
@@ -1024,7 +1024,7 @@
- Creates the record in the database
+ Creates the record in the database
Practically it invokes
BaseResource#create.
When validation error occurs it stores that to BaseResource#errors
@@ -1149,7 +1149,7 @@
- Returns error message for given property path (name)
+ Returns error message for given property path (name)
@@ -1325,8 +1325,8 @@
- Returns unflatten (regular) value for given field. So if you have in the params following
-structure:
+ Returns unflatten (regular) value for given field. So if you have in the params following
+structure:
params = {
genre.0: 'male',
genre.1: 'female',
@@ -1553,7 +1553,7 @@
- Returns uniq id of the Record.
+ Returns uniq id of the Record.
@@ -1678,7 +1678,7 @@
- Return state of validation for given record
+ Return state of validation for given record
@@ -1800,7 +1800,7 @@
- Returns object containing all params keys starting with prefix
+ Returns object containing all params keys starting with prefix
@@ -1976,7 +1976,7 @@
- Returns value for given field.
+ Returns value for given field.
@@ -2153,7 +2153,7 @@
- Populate record relations
+ Populate record relations
@@ -2377,8 +2377,8 @@
- Saves the record in the database. When record already exists - it updates, otherwise
-it creates new one.
+ Saves the record in the database. When record already exists - it updates, otherwise
+it creates new one.
Practically it invokes
BaseResource#create or BaseResource#update methods.
When validation error occurs it stores that to BaseResource#errors
@@ -2503,7 +2503,7 @@
- Returns object containing all params keys starting with prefix
+ Returns object containing all params keys starting with prefix
@@ -2722,8 +2722,8 @@
- Sets given value under the propertyPath. Value is flatten and all previous values under this
-path are replaced. When value is undefined function just clears the old values
+ Sets given value under the propertyPath. Value is flatten and all previous values under this
+path are replaced. When value is undefined function just clears the old values
@@ -2913,7 +2913,7 @@
- Stores incoming payloadData in record params
+ Stores incoming payloadData in record params
@@ -3096,8 +3096,8 @@
- Returns title of the record. Usually title is an value for fields like: email, topic,
-title etc.
+ Returns title of the record. Usually title is an value for fields like: email, topic,
+title etc.
Title will be shown in the breadcrumbs for example.
@@ -3220,7 +3220,7 @@
- Returns JSON representation of an record
+ Returns JSON representation of an record
@@ -3407,8 +3407,8 @@
- Updates given Record in the data store. Practically it invokes
-BaseResource.update method.
+ Updates given Record in the data store. Practically it invokes
+BaseResource.update method.
When validation error occurs it stores that to BaseResource.errors
diff --git a/docs/BaseResource.html b/docs/BaseResource.html
index 14ad6fb0..995a3efa 100644
--- a/docs/BaseResource.html
+++ b/docs/BaseResource.html
@@ -348,8 +348,8 @@
- Checks if given adapter supports resource provided by the user.
-This function has to be implemented only if you want to create your custom
+ Checks if given adapter supports resource provided by the user.
+
This function has to be implemented only if you want to create your custom
database adapter.
For one time Admin Resource creation - it is not needed.
@@ -524,7 +524,7 @@
- Builds new Record of given Resource.
+ Builds new Record of given Resource.
Each Record is an representation of the resource item. Before it can be saved,
it has to be instantiated.
This function has to be implemented if you want to create new records.
@@ -704,7 +704,7 @@
- Returns number of elements for given resource by including filters
+ Returns number of elements for given resource by including filters
@@ -881,7 +881,7 @@
- Creates new record
+ Creates new record
@@ -1080,8 +1080,8 @@
- The name of the database to which resource belongs. When resource is
-a mongoose model it should be database name of the mongo database.
+ The name of the database to which resource belongs. When resource is
+a mongoose model it should be database name of the mongo database.
Visually, by default, all resources are nested in sidebar under their database names.
@@ -1204,8 +1204,8 @@
- Returns type of the database. It is used to compute sidebar icon for
-given resource. Default: 'database'
+ Returns type of the database. It is used to compute sidebar icon for
+given resource. Default: 'database'
@@ -1325,7 +1325,7 @@
- Gets decorator object for given resource
+ Gets decorator object for given resource
@@ -1454,7 +1454,7 @@
- Delete given record by id
+ Delete given record by id
@@ -1655,7 +1655,7 @@
- Returns actual records for given resource
+ Returns actual records for given resource
@@ -2054,7 +2054,7 @@
- Finds many records based on the resource ids
+ Finds many records based on the resource ids
@@ -2233,7 +2233,7 @@
- Finds one Record in the Resource by its id
+ Finds one Record in the Resource by its id
@@ -2413,8 +2413,8 @@
- Each resource has to have uniq id which will be put to an URL of AdminJS routes.
-For instance in Router path for the new form is /resources/{resourceId}/new
+ Each resource has to have uniq id which will be put to an URL of AdminJS routes.
+For instance in Router path for the new form is /resources/{resourceId}/new
@@ -2540,7 +2540,7 @@
- returns array of all properties which belongs to resource
+ returns array of all properties which belongs to resource
@@ -2664,7 +2664,7 @@
- returns property object for given field
+ returns property object for given field
@@ -2846,7 +2846,7 @@
- Updates an the record.
+ Updates an the record.
diff --git a/docs/BaseResource_BaseResource.html b/docs/BaseResource_BaseResource.html
index ba60d9e3..fc5d5311 100644
--- a/docs/BaseResource_BaseResource.html
+++ b/docs/BaseResource_BaseResource.html
@@ -221,7 +221,7 @@
- Creates given resource based on the raw resource object
+ Creates given resource based on the raw resource object
diff --git a/docs/Button.html b/docs/Button.html
index 86a2d8a4..58b77a68 100644
--- a/docs/Button.html
+++ b/docs/Button.html
@@ -328,7 +328,7 @@
- Button CSS Styles which can be reused in another button-like component with styled-components
+ Button CSS Styles which can be reused in another button-like component with styled-components
Usage:
import { ButtonCSS } from '@adminjs/design-system'
import { Link } from 'react-router-dom'
diff --git a/docs/ButtonGroup.html b/docs/ButtonGroup.html
index f6d6d61a..721ac793 100644
--- a/docs/ButtonGroup.html
+++ b/docs/ButtonGroup.html
@@ -334,7 +334,7 @@
- Props passed to ButtonGroup element.
+ Props passed to ButtonGroup element.
@@ -533,7 +533,7 @@
- Props of buttons in ButtonGroup
+ Props of buttons in ButtonGroup
diff --git a/docs/CurrentUserNav.html b/docs/CurrentUserNav.html
index 64738ca4..5fa7619e 100644
--- a/docs/CurrentUserNav.html
+++ b/docs/CurrentUserNav.html
@@ -336,7 +336,7 @@
- Action element passed to CurrentUserNavProps
+ Action element passed to CurrentUserNavProps
@@ -597,7 +597,7 @@
- Props passed to CurrentUserNav component
+ Props passed to CurrentUserNav component
diff --git a/docs/DatePicker.html b/docs/DatePicker.html
index 4f2e4508..169ca8e3 100644
--- a/docs/DatePicker.html
+++ b/docs/DatePicker.html
@@ -361,7 +361,7 @@
- Props for DatePicker
+ Props for DatePicker
diff --git a/docs/Drawer.html b/docs/Drawer.html
index 5bb30ac6..238187f6 100644
--- a/docs/Drawer.html
+++ b/docs/Drawer.html
@@ -363,8 +363,8 @@
- Props for Drawer component. Apart from those described below it also extends all
-SpaceProps.
+ Props for Drawer component. Apart from those described below it also extends all
+
diff --git a/docs/DrawerPortal.html b/docs/DrawerPortal.html
index a67ba563..4922cafc 100644
--- a/docs/DrawerPortal.html
+++ b/docs/DrawerPortal.html
@@ -222,8 +222,8 @@
- Shows all of its children in a Drawer on the right.
-Instead of rendering it's own Drawer component it reuses
+ Shows all of its children in a Drawer on the right.
+
Instead of rendering it's own Drawer component it reuses
the global Drawer via React Portal.
Usage
import { DrawerPortal } from 'adminjs'
diff --git a/docs/DropDown.html b/docs/DropDown.html
index a10c6247..c98fd551 100644
--- a/docs/DropDown.html
+++ b/docs/DropDown.html
@@ -334,8 +334,8 @@
-