| \n | \n {this._get_table_header()}\n
|---|
\n {\n this.setState({ display_type: display_type.list, object: null });\n this.get_queryset(\n this.state.page_number,\n this.get_list_per_page(),\n this.state.queryset\n );\n }}\n >\n {\" \"}\n Back{\" \"}\n \n
\n );\n }\n /**\n * Renders the admin interface component\n *\n * @return A component that renders the admin interface\n */\n render_list_view() {\n return (\n \n {this.render_add_button()}\n {this.render_below_add_button()}\n {this.render_search_field()}\n {this.render_below_search_field()}\n {this.render_actions()}\n {this.render_below_actions()}\n {this.render_filters()}\n {this.render_below_filters()}\n\n {this.render_table()}\n {this.render_below_table()}\n {this.render_progress(this.state.loading)}\n {this.render_below_progress()}\n\n {this.render_pagination()}\n
\n );\n }\n render_below_add_button() {}\n render_below_search_field() {}\n\n render_below_actions() {}\n\n render_below_filters() {}\n\n render_below_table() {}\n\n render_below_progress() {}\n\n render_change_view() {\n return (\n \n {this.render_progress(this.state.loading)}\n {this.render_back_button()}\n {this.get_form(this.state.object)}\n
\n );\n }\n render_above_change_view() {}\n render_below_change_view() {}\n render_above_list_view() {}\n render_below_list_view() {}\n render_list_page() {\n return (\n \n {this.render_above_list_view()}\n {this.render_list_view()}\n {this.render_below_list_view()}\n {this.render_change_modal()}\n
\n );\n }\n\n render_change_modal() {\n return (\n \n {\" \"}\n
\n );\n }\n render() {\n if (!this.has_module_permission()) {\n return this.render_permission_denied();\n }\n\n return Permission Denied
\n{this.render_list_page()}
;\n }\n show_list_view() {\n this._display_will_change();\n this.setState({ display_type: display_type.list }, this._display_changed);\n }\n}\n\nexport default Admin;\n",
"static": true,
"longname": "/home/mubarak/Dropbox/Projects/react-crud-admin/src/admin.js",
"access": "public",
"description": null,
"lineNumber": 1
},
{
"__docId__": 49,
"kind": "variable",
"name": "uuidv1",
"memberof": "src/admin.js",
"static": true,
"longname": "src/admin.js~uuidv1",
"access": "public",
"export": false,
"importPath": "react-crud-admin/src/admin.js",
"importStyle": null,
"description": null,
"lineNumber": 6,
"undocument": true,
"type": {
"types": [
"*"
]
},
"ignore": true
},
{
"__docId__": 50,
"kind": "variable",
"name": "display_type",
"memberof": "src/admin.js",
"static": true,
"longname": "src/admin.js~display_type",
"access": "public",
"export": true,
"importPath": "react-crud-admin/src/admin.js",
"importStyle": "{display_type}",
"description": null,
"lineNumber": 9,
"undocument": true,
"type": {
"types": [
"{\"list\": string, \"change\": string}"
]
}
},
{
"__docId__": 51,
"kind": "variable",
"name": "customStyles",
"memberof": "src/admin.js",
"static": true,
"longname": "src/admin.js~customStyles",
"access": "public",
"export": false,
"importPath": "react-crud-admin/src/admin.js",
"importStyle": null,
"description": null,
"lineNumber": 13,
"undocument": true,
"type": {
"types": [
"{\"content\": *}"
]
},
"ignore": true
},
{
"__docId__": 52,
"kind": "class",
"name": "Admin",
"memberof": "src/admin.js",
"static": true,
"longname": "src/admin.js~Admin",
"access": "public",
"export": true,
"importPath": "react-crud-admin/src/admin.js",
"importStyle": "Admin",
"description": "Admin Class extends React.Component. To implement a CRUD interface similar to Django Admin you need to extend the Admin class.",
"lineNumber": 24,
"interface": false,
"extends": [
"react~React.Component"
]
},
{
"__docId__": 53,
"kind": "constructor",
"name": "constructor",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#constructor",
"access": "public",
"description": null,
"lineNumber": 25,
"undocument": true
},
{
"__docId__": 54,
"kind": "member",
"name": "name",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#name",
"access": "public",
"description": null,
"lineNumber": 28,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 55,
"kind": "member",
"name": "name_plural",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#name_plural",
"access": "public",
"description": null,
"lineNumber": 29,
"undocument": true,
"type": {
"types": [
"string"
]
}
},
{
"__docId__": 56,
"kind": "member",
"name": "live_search",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#live_search",
"access": "public",
"description": null,
"lineNumber": 30,
"undocument": true,
"type": {
"types": [
"boolean"
]
}
},
{
"__docId__": 57,
"kind": "member",
"name": "field_transforms",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#field_transforms",
"access": "public",
"description": null,
"lineNumber": 31,
"undocument": true,
"type": {
"types": [
"{}"
]
}
},
{
"__docId__": 58,
"kind": "member",
"name": "header_transforms",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#header_transforms",
"access": "public",
"description": null,
"lineNumber": 32,
"undocument": true,
"type": {
"types": [
"{}"
]
}
},
{
"__docId__": 59,
"kind": "member",
"name": "extra_fields",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#extra_fields",
"access": "public",
"description": null,
"lineNumber": 33,
"undocument": true,
"type": {
"types": [
"{}"
]
}
},
{
"__docId__": 60,
"kind": "member",
"name": "list_display",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#list_display",
"access": "public",
"description": null,
"lineNumber": 34,
"undocument": true,
"type": {
"types": [
"*[]"
]
}
},
{
"__docId__": 61,
"kind": "member",
"name": "list_display_links",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#list_display_links",
"access": "public",
"description": null,
"lineNumber": 35,
"undocument": true,
"type": {
"types": [
"*[]"
]
}
},
{
"__docId__": 62,
"kind": "member",
"name": "list_per_page",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#list_per_page",
"access": "public",
"description": null,
"lineNumber": 36,
"undocument": true,
"type": {
"types": [
"number"
]
}
},
{
"__docId__": 63,
"kind": "member",
"name": "sort_fields",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#sort_fields",
"access": "public",
"description": null,
"lineNumber": 37,
"undocument": true,
"type": {
"types": [
"*[]"
]
}
},
{
"__docId__": 64,
"kind": "member",
"name": "is_object_equal",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#is_object_equal",
"access": "public",
"description": null,
"lineNumber": 38,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 65,
"kind": "member",
"name": "pages_in_pagination",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#pages_in_pagination",
"access": "public",
"description": null,
"lineNumber": 39,
"undocument": true,
"type": {
"types": [
"number"
]
}
},
{
"__docId__": 66,
"kind": "member",
"name": "actions",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#actions",
"access": "public",
"description": null,
"lineNumber": 40,
"undocument": true,
"type": {
"types": [
"{\"delete\": *}"
]
}
},
{
"__docId__": 67,
"kind": "member",
"name": "_change_uuid",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#_change_uuid",
"access": "private",
"description": null,
"lineNumber": 43,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 68,
"kind": "member",
"name": "queryset",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#queryset",
"access": "public",
"description": null,
"lineNumber": 44,
"undocument": true,
"type": {
"types": [
"*[]"
]
}
},
{
"__docId__": 69,
"kind": "member",
"name": "_all_selected",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#_all_selected",
"access": "private",
"description": null,
"lineNumber": 45,
"undocument": true,
"type": {
"types": [
"boolean"
]
}
},
{
"__docId__": 70,
"kind": "member",
"name": "bind_exclude",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#bind_exclude",
"access": "public",
"description": null,
"lineNumber": 48,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 71,
"kind": "member",
"name": "[key]",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#[key]",
"access": "public",
"description": null,
"lineNumber": 52,
"undocument": true,
"type": {
"types": [
"*"
]
}
},
{
"__docId__": 73,
"kind": "member",
"name": "state",
"memberof": "src/admin.js~Admin",
"static": false,
"longname": "src/admin.js~Admin#state",
"access": "public",
"description": "Initialize the state of the component",
"lineNumber": 65,
"type": {
"types": [
"{\"display_type\": *, \"page_number\": number, \"object\": *, \"selected_objects\": *, \"total\": number, \"filter_options\": *, \"filter_values\": *}"
]
}
},
{
"__docId__": 79,
"kind": "method",
"name": "get_queryset",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_queryset",
"access": "public",
"description": "This function returns an array of objects that will serve as the\nqueryset for the admin interface. Typically involves an HTTP request\nto a backend.",
"lineNumber": 104,
"unknown": [
{
"tagName": "@returns",
"tagValue": "{object[]} An array of objects. - Objects to display"
}
],
"params": [
{
"nullable": null,
"types": [
"number"
],
"spread": false,
"optional": false,
"name": "page_number",
"description": "The current page number"
},
{
"nullable": null,
"types": [
"number"
],
"spread": false,
"optional": false,
"name": "list_per_page",
"description": "Number items to list per page. Defaults to `list_per_page`"
},
{
"nullable": null,
"types": [
"object[]"
],
"spread": false,
"optional": false,
"name": "queryset",
"description": "The current queryset"
}
],
"return": {
"nullable": null,
"types": [
"object[]"
],
"spread": false,
"description": "An array of objects. - Objects to display"
}
},
{
"__docId__": 80,
"kind": "method",
"name": "get_form",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_form",
"access": "public",
"description": "This functions returns a JSON Schema Form for editing\nthe objects in the array returned by get_queryset(). This method needs to be overridden to\nso as to return a Form Component for the object. Learn more on\nJSON schema forms from https://github.com/mozilla-services/react-jsonschema-form\nand JSON Schema from https://spacetelescope.github.io/understanding-json-schema/",
"lineNumber": 122,
"unknown": [
{
"tagName": "@returns",
"tagValue": " A JSON Schema Form Component."
}
],
"params": [
{
"nullable": null,
"types": [
"object"
],
"spread": false,
"optional": false,
"name": "object",
"description": "The current selected object."
}
],
"return": {
"nullable": null,
"types": [
"*"
],
"spread": false,
"description": "A JSON Schema Form Component."
}
},
{
"__docId__": 81,
"kind": "method",
"name": "get_live_search",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_live_search",
"access": "public",
"description": "Returns a true/false value. Controls wether search is implement on live input or not.\nCan be overriden by the live_search member variable. Default is false.",
"lineNumber": 132,
"return": {
"nullable": null,
"types": [
"boolean"
],
"spread": false,
"description": ""
},
"params": []
},
{
"__docId__": 82,
"kind": "method",
"name": "get_field_transforms",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_field_transforms",
"access": "public",
"description": "Returns an object whose properties are field names corresponding to properties of any object\nin the queryset and whose values are transform functions. The example below will transform each \"name\"\nproperty of objects in the queryset to upper case in the list display view.",
"examples": [
"get_field_transforms()\n{\nreturn { 'name' : function(name,object)\n {\n return name.toUpperCase()\n }\n }\n\n}"
],
"lineNumber": 153,
"return": {
"nullable": null,
"types": [
"object"
],
"spread": false,
"description": ""
},
"params": []
},
{
"__docId__": 83,
"kind": "method",
"name": "get_header_transforms",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_header_transforms",
"access": "public",
"description": "Returns an object whose properties are field names corresponding to properties of any object\nin the queryset and whose values are transform functions. The example below will transform the header \"name\" to upper case in the list display view.",
"examples": [
"get_header_transforms()\n{\nreturn { 'name' : function(name)\n {\n return name.toUpperCase()\n }\n }\n}"
],
"lineNumber": 176,
"return": {
"nullable": null,
"types": [
"object"
],
"spread": false,
"description": ""
},
"params": []
},
{
"__docId__": 84,
"kind": "method",
"name": "get_extra_fields",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_extra_fields",
"access": "public",
"description": "Returns an object whose properties are extra field names not corresponding to properties of any object\nin the queryset and whose values are display functions. This will create extra fields that are not tied to objects. Extra fields have to be manually included in the `list_display` in order to appear in the list display page. The display functions take the current object being rendered in the table row and the field name",
"examples": [
"get_extra_fields()\n{\nreturn { 'now' : function(object,label)\n {\n return moment(new Date()).format('LLL');\n }\n }\n}"
],
"lineNumber": 200,
"return": {
"nullable": null,
"types": [
"object"
],
"spread": false,
"description": ""
},
"params": []
},
{
"__docId__": 85,
"kind": "method",
"name": "get_list_per_page",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_list_per_page",
"access": "public",
"description": "Returns the number of items to be listed in a page. Can be overridden by `list_per_page`.",
"lineNumber": 212,
"return": {
"nullable": null,
"types": [
"number"
],
"spread": false,
"description": "The number of objects in a page"
},
"params": []
},
{
"__docId__": 86,
"kind": "method",
"name": "get_actions",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_actions",
"access": "public",
"description": "Gets an actions object whose properties are action names and values are action methods.\nThis can be overridden by the action member variable. The default \"delete\" method is not\nimplemented.\n\nEach actions object property (e.g. \"delete\") is passed an array of selected objects. One\ncan then handle those objects. Actions will appear on the list display page within a\ndropdown. Selecting an action should have the action method applied to all currently \nselected objects.",
"examples": [
"\nactions = { \"delete\" : (selected_objects)=>{ } }"
],
"lineNumber": 235,
"return": {
"nullable": null,
"types": [
"object"
],
"spread": false,
"description": "An actions object"
},
"params": []
},
{
"__docId__": 87,
"kind": "method",
"name": "get_list_display_links",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_list_display_links",
"access": "public",
"description": " Gets the list/array of properties of the objects in the queryset that are clickable\n when displayed on the list display page. It can be overridden by the member variable\n `list_display_links`. A property is any string that should exist as a property in the objects within\n a queryset and works with lodash's `_.at` function.\n\n The properties \"name\",\"address.street\" and \"emails[0]\" are all acceptable by `_.at` in the example below",
"examples": [
" let object={ name : \"any name\",{ address : { street : \"any\"}},emails: [\"any@any.com\"]}"
],
"lineNumber": 257,
"return": {
"nullable": null,
"types": [
"string[]"
],
"spread": false,
"description": "A list of properties of the object to be displayed"
},
"params": []
},
{
"__docId__": 88,
"kind": "method",
"name": "get_list_display",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_list_display",
"access": "public",
"description": " Gets the list/array of properties/field names of the objects in the queryset to be\n displayed on the list display page. It can be overridden by the member variable\n list_display. A property is any string that should exist in the objects within\n a queryset and works with lodash's _.at function. See more at\n https://lodash.com/docs/#at",
"examples": [
" let object={ name : \"any name\",{ address : { street : \"any\"}},emails: [\"any@any.com\"]}\n\n The properties \"name\",\"address.street\" and \"emails[0]\" are all acceptable"
],
"lineNumber": 278,
"return": {
"nullable": null,
"types": [
"string[]"
],
"spread": false,
"description": "A list of properties of the object to be displayed"
},
"params": []
},
{
"__docId__": 89,
"kind": "method",
"name": "_get_ordered_queryset",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_get_ordered_queryset",
"access": "private",
"description": "Returns an ordered queryset. The method checks to see if sorting is active and sorts\nthe current queryset based on the sort order.",
"lineNumber": 291,
"return": {
"nullable": null,
"types": [
"object[]"
],
"spread": false,
"description": "An ordered queryset"
},
"params": []
},
{
"__docId__": 90,
"kind": "method",
"name": "search",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#search",
"access": "public",
"description": "Implements search. This method should be overridden to implement a custom search",
"lineNumber": 306,
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "term",
"description": "the search term"
},
{
"nullable": null,
"types": [
"object[]"
],
"spread": false,
"optional": false,
"name": "queryset",
"description": "the current queryset"
}
],
"return": {
"nullable": null,
"types": [
"object[]"
],
"spread": false,
"description": "the queryset as a result of the search"
}
},
{
"__docId__": 91,
"kind": "method",
"name": "has_delete_permission",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#has_delete_permission",
"access": "public",
"description": "Grants permission to delete object. This method is not implemented and can be handled via\n implementing actions.",
"lineNumber": 317,
"params": [
{
"nullable": null,
"types": [
"object"
],
"spread": false,
"optional": false,
"name": "object",
"description": ""
}
],
"return": {
"nullable": null,
"types": [
"boolean"
],
"spread": false,
"description": "Returns true is the object has been deleted or false otherwise"
}
},
{
"__docId__": 92,
"kind": "method",
"name": "has_add_permission",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#has_add_permission",
"access": "public",
"description": "Grants permission to add an object. This method controls rendering of the Add\nbutton",
"lineNumber": 328,
"return": {
"nullable": null,
"types": [
"boolean"
],
"spread": false,
"description": "Returns true is the object can be added or false otherwise"
},
"params": []
},
{
"__docId__": 93,
"kind": "method",
"name": "has_change_permission",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#has_change_permission",
"access": "public",
"description": "Grants permission to change an object. It disables all links to the add/change page when\nenabled",
"lineNumber": 338,
"return": {
"nullable": null,
"types": [
"boolean"
],
"spread": false,
"description": "Returns true is the object can be changed or false otherwise"
},
"params": [
{
"name": "object",
"optional": true,
"types": [
"undefined"
],
"defaultValue": "undefined"
}
]
},
{
"__docId__": 94,
"kind": "method",
"name": "has_module_permission",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#has_module_permission",
"access": "public",
"description": "Grants permission to the this admin interface.",
"lineNumber": 347,
"return": {
"nullable": null,
"types": [
"boolean"
],
"spread": false,
"description": "Returns true if access is allowed false otherwise"
},
"params": []
},
{
"__docId__": 95,
"kind": "method",
"name": "_order_state_arrow",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_order_state_arrow",
"access": "private",
"description": "This method adds up/down arrows to field headers on the list display page table",
"lineNumber": 378,
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "field",
"description": "the field/property name"
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 96,
"kind": "method",
"name": "response_add",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#response_add",
"access": "public",
"description": " This method should be overriden and called after saving an object in the add/change view. * This method is not called at all here but provides hints on what to do after saving\n an object. Change the state display_type to \"list\", object to \"null\" and refresh the quer * yset.",
"lineNumber": 396,
"params": [],
"return": {
"types": [
"boolean"
]
}
},
{
"__docId__": 97,
"kind": "method",
"name": "response_change",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#response_change",
"access": "public",
"description": " This method should be overriden and called after saving an object in the add/change view. * This method is not called at all here but provides hints on what to do after saving\n an object. Change the state display_type to \"list\", object to \"null\" and refresh the quer * yset.",
"lineNumber": 418,
"params": [],
"return": {
"types": [
"boolean"
]
}
},
{
"__docId__": 98,
"kind": "method",
"name": "_create_object_link",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_create_object_link",
"access": "private",
"description": "A private method to wrap a table entry in an tag in the display page.\nThe method checks if permission is given to display links using the has_change_permission method",
"lineNumber": 445,
"params": [
{
"nullable": null,
"types": [
"object"
],
"spread": false,
"optional": false,
"name": "object",
"description": "the current object to be displayed as a table\nentry in the display page"
},
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "label",
"description": "the name of the field"
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 99,
"kind": "method",
"name": "set_queryset",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#set_queryset",
"access": "public",
"description": null,
"lineNumber": 458,
"undocument": true,
"params": [
{
"name": "queryset",
"types": [
"*"
]
}
],
"return": null
},
{
"__docId__": 100,
"kind": "method",
"name": "set_total",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#set_total",
"access": "public",
"description": null,
"lineNumber": 462,
"undocument": true,
"params": [
{
"name": "total",
"types": [
"*"
]
}
],
"return": null
},
{
"__docId__": 101,
"kind": "method",
"name": "_get_prop_label",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_get_prop_label",
"access": "private",
"description": null,
"lineNumber": 466,
"undocument": true,
"params": [
{
"name": "label",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 102,
"kind": "method",
"name": "_get_table_header",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_get_table_header",
"access": "private",
"description": null,
"lineNumber": 470,
"undocument": true,
"params": [],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 103,
"kind": "method",
"name": "_display_changed",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_display_changed",
"access": "private",
"description": null,
"lineNumber": 483,
"undocument": true,
"params": [],
"return": null
},
{
"__docId__": 104,
"kind": "method",
"name": "display_changed",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#display_changed",
"access": "public",
"description": "An event listener that listens to state changes in the display type i.e.\nfrom list to add/change. It is fired after state changes are made.",
"lineNumber": 495,
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "display_type",
"description": "the current display type of the component either \"list\" or \"change\""
},
{
"nullable": null,
"types": [
"object"
],
"spread": false,
"optional": false,
"name": "object",
"description": "the current object or null"
}
],
"return": null
},
{
"__docId__": 105,
"kind": "method",
"name": "_display_will_change",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_display_will_change",
"access": "private",
"description": null,
"lineNumber": 496,
"undocument": true,
"params": [],
"return": null
},
{
"__docId__": 106,
"kind": "method",
"name": "display_will_change",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#display_will_change",
"access": "public",
"description": "An event listener that listens to state changes in the display type i.e.\nfrom list to add/change . It is fired before state changes are made.",
"lineNumber": 508,
"params": [
{
"nullable": null,
"types": [
"string"
],
"spread": false,
"optional": false,
"name": "display_type",
"description": "the current display type of the component either \"list\" or \"change\""
},
{
"nullable": null,
"types": [
"object"
],
"spread": false,
"optional": false,
"name": "object",
"description": "the current object or null"
}
],
"return": null
},
{
"__docId__": 107,
"kind": "method",
"name": "_object_link_clicked",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_object_link_clicked",
"access": "private",
"description": null,
"lineNumber": 509,
"undocument": true,
"params": [
{
"name": "object",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 108,
"kind": "method",
"name": "_display_field",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_display_field",
"access": "private",
"description": null,
"lineNumber": 520,
"undocument": true,
"params": [
{
"name": "object",
"types": [
"*"
]
},
{
"name": "item",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 109,
"kind": "method",
"name": "set_filter_options",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#set_filter_options",
"access": "public",
"description": null,
"lineNumber": 536,
"undocument": true,
"params": [
{
"name": "filter_name",
"types": [
"*"
]
},
{
"name": "options",
"types": [
"*"
]
}
],
"return": null
},
{
"__docId__": 110,
"kind": "method",
"name": "get_filter_values",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_filter_values",
"access": "public",
"description": null,
"lineNumber": 545,
"undocument": true,
"params": [],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 111,
"kind": "method",
"name": "get_filters",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#get_filters",
"access": "public",
"description": null,
"lineNumber": 548,
"undocument": true,
"params": [],
"return": null
},
{
"__docId__": 112,
"kind": "method",
"name": "_handle_filter_change",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_handle_filter_change",
"access": "private",
"description": null,
"lineNumber": 568,
"undocument": true,
"params": [
{
"name": "values",
"types": [
"*"
]
}
],
"return": null
},
{
"__docId__": 113,
"kind": "method",
"name": "render_filters",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#render_filters",
"access": "public",
"description": null,
"lineNumber": 595,
"undocument": true,
"params": [],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 114,
"kind": "method",
"name": "sort_by",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#sort_by",
"access": "public",
"description": null,
"lineNumber": 635,
"undocument": true,
"params": [
{
"name": "sort_fields",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 115,
"kind": "method",
"name": "_sort_handler",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_sort_handler",
"access": "private",
"description": null,
"lineNumber": 639,
"undocument": true,
"params": [
{
"name": "field",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 117,
"kind": "method",
"name": "_select_all",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_select_all",
"access": "private",
"description": "This method is an event handler that listens to when all objects of the queryset\ndisplayed within a single display page are selected",
"lineNumber": 668,
"params": [
{
"name": "event",
"types": [
"*"
]
}
],
"return": null
},
{
"__docId__": 119,
"kind": "method",
"name": "_select_one",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_select_one",
"access": "private",
"description": "This method is an event handler that listens when a single objects of the queryset\ndisplayed is selected",
"lineNumber": 683,
"params": [
{
"name": "object",
"types": [
"*"
]
}
],
"return": {
"types": [
"*"
]
}
},
{
"__docId__": 120,
"kind": "method",
"name": "_get_table_body",
"memberof": "src/admin.js~Admin",
"generator": false,
"async": false,
"static": false,
"longname": "src/admin.js~Admin#_get_table_body",
"access": "private",
"description": "Generate the table body for the list display page",
"lineNumber": 702,
"return": {
"nullable": null,
"types": [
"*"
],
"spread": false,
"description": "An array of table rows Something went wrong.
;\n }\n return this.props.children;\n }\n}\nReactDOM.render(\n\n {\" \"}\n
\n );\n }\n\n if (this.state.display_type == display_type.list) {\n return this.render_list_page();\n } else {\n //Important: the next two lines are for URL navigation and handling the browser back button\n this._change_uuid = uuidv1();\n history.pushState(\n {},\n \"Change View\",\n window.location.hash + \"/change/\" + this._change_uuid\n );\n\n return this.render_change_page();\n }\n}\n```\nYou can also listen to events that are triggered when the display is about to change or has changed,\n\n```javascript\ndisplay_will_change(display_type,object)\n{\n\n}\n```\nand\n```javascript\ndisplay_changed(display_type,object)\n{\n\n}\n```\n`display_type` is either `\"list\"` or `\"change\"`.\n\n### List Page\n\nIt is possible to add components above and below the list view using `render_above_list_view` and `render_below_list_view` methods. Both methods take no arguments and by default return `null`. These methods can be overridden to return components.\n\n```javascript\nrender_list_page();\n{\n return (\n Permission Denied
\n\n {this.render_above_list_view()}\n {this.render_list_view()}\n {this.render_below_list_view()}\n
\n );\n}\n```\n\nWithin the `render_list_view` method itself, customisations are possible. The full implementation of `render_list_view` is,\n\n```javascript\nrender_list_view();\n{\n return (\n \n {this.render_add_button()}\n {this.render_below_add_button()}\n {this.render_search_field()}\n {this.render_below_search_field()}\n {this.render_actions()}\n {this.render_below_actions()}\n {this.render_filters()}\n {this.render_below_filters()}\n {this.render_table()}\n {this.render_below_table()}\n {this.render_progress(this.state.loading)}\n {this.render_below_progress()}\n {this.render_pagination()}\n
\n );\n}\n```\n\nThe `render_below_*` methods are used to add components below the add button, search field, actions,filters,list table and progress indicator. By default these methods return `null`. These methods can be overridden to return components.\n\nIt is also worth noting that one can hide any of the components by the overriding their methods and returning null. For example to hide the actions component, we override the `render_actions` method.\n\n```javascript\nrender_actions();\n{\n}\n```\n\n### The Add/Change Page\n\nIt is possible to add components above and below the add/change view using `render_above_change_view` and `render_below_change_view` methods. Both methods take no arguments and by default return `null`. These methods can be overridden to return components. The full implementation is\n\n```javascript\nrender_change_page();\n{\n return (\n \n {this.render_above_change_view()}\n {this.render_change_view()}\n {this.render_below_change_view()}\n
\n );\n}\n```\n",
"longname": "/home/mubarak/Dropbox/Projects/react-crud-admin/README.md",
"name": "./README.md",
"static": true,
"access": "public"
},
{
"kind": "packageJSON",
"content": "{\n \"name\": \"react-crud-admin\",\n \"version\": \"1.0.48\",\n \"private\": false,\n \"main\": \"build/static/js/main.js\",\n \"description\": \"React Admin inspired by DjangoAdmin\",\n \"dependencies\": {\n \"lodash\": \"\",\n \"react\": \"\",\n \"react-jsonschema-form\": \"\",\n \"react-modal\": \"\",\n \"react-select\": \"\",\n \"uuid\": \"\"\n },\n \"devDependencies\": {\n \"@babel/core\": \"7.2.2\",\n \"@svgr/webpack\": \"4.1.0\",\n \"babel-core\": \"7.0.0-bridge.0\",\n \"babel-eslint\": \"9.0.0\",\n \"babel-jest\": \"23.6.0\",\n \"babel-loader\": \"8.0.5\",\n \"babel-plugin-named-asset-import\": \"^0.3.1\",\n \"babel-preset-react-app\": \"^7.0.2\",\n \"bfj\": \"6.1.1\",\n \"bootstrap\": \"^4.3.1\",\n \"bootstrap-sass\": \"^3.4.1\",\n \"case-sensitive-paths-webpack-plugin\": \"2.2.0\",\n \"css-loader\": \"1.0.0\",\n \"dotenv\": \"6.0.0\",\n \"dotenv-expand\": \"4.2.0\",\n \"eslint\": \"5.12.0\",\n \"eslint-config-react-app\": \"^3.0.7\",\n \"eslint-loader\": \"2.1.1\",\n \"eslint-plugin-flowtype\": \"2.50.1\",\n \"eslint-plugin-import\": \"2.14.0\",\n \"eslint-plugin-jsx-a11y\": \"6.1.2\",\n \"eslint-plugin-react\": \"7.12.4\",\n \"file-loader\": \"2.0.0\",\n \"fork-ts-checker-webpack-plugin-alt\": \"0.4.14\",\n \"fs-extra\": \"7.0.1\",\n \"html-webpack-plugin\": \"4.0.0-alpha.2\",\n \"identity-obj-proxy\": \"3.0.0\",\n \"jest\": \"23.6.0\",\n \"jest-pnp-resolver\": \"1.0.2\",\n \"jest-resolve\": \"23.6.0\",\n \"jest-watch-typeahead\": \"^0.2.1\",\n \"mini-css-extract-plugin\": \"0.5.0\",\n \"moment\": \"^2.24.0\",\n \"node-sass\": \"^4.11.0\",\n \"optimize-css-assets-webpack-plugin\": \"5.0.1\",\n \"pnp-webpack-plugin\": \"1.2.1\",\n \"postcss-flexbugs-fixes\": \"4.1.0\",\n \"postcss-loader\": \"3.0.0\",\n \"postcss-preset-env\": \"6.5.0\",\n \"postcss-safe-parser\": \"4.0.1\",\n \"react-app-polyfill\": \"^0.2.1\",\n \"react-dev-utils\": \"^7.0.3\",\n \"react-dom\": \"^16.8.3\",\n \"react-jsonschema-form\": \"^1.2.1\",\n \"resolve\": \"1.10.0\",\n \"sass-loader\": \"7.1.0\",\n \"style-loader\": \"0.23.1\",\n \"terser-webpack-plugin\": \"1.2.2\",\n \"url-loader\": \"1.1.2\",\n \"webpack\": \"4.28.3\",\n \"webpack-dev-server\": \"3.1.14\",\n \"webpack-manifest-plugin\": \"2.0.4\",\n \"workbox-webpack-plugin\": \"3.6.3\"\n },\n \"scripts\": {\n \"edocs\": \"esdoc -c .esdoc.json\",\n \"build\": \"node scripts/build.js\",\n \"build-publish\": \"node scripts/buildpublish.js\",\n \"start\": \"node scripts/start.js\",\n \"test\": \"node scripts/test.js\"\n },\n \"eslintConfig\": {\n \"extends\": \"react-app\"\n },\n \"browserslist\": [\n \">0.2%\",\n \"not dead\",\n \"not ie <= 11\",\n \"not op_mini all\"\n ],\n \"jest\": {\n \"collectCoverageFrom\": [\n \"src/**/*.{js,jsx,ts,tsx}\",\n \"!src/**/*.d.ts\"\n ],\n \"resolver\": \"jest-pnp-resolver\",\n \"setupFiles\": [\n \"react-app-polyfill/jsdom\"\n ],\n \"testMatch\": [\n \"