django-bananas
v4.1.2
Published
React admin frontend for Django.
Downloads
135
Readme
django-bananas.js
npm install django-bananas react react-dom @material-ui/core @material-ui/icons final-form final-form-arrays react-final-form react-final-form-arrays
import Bananas from "django-bananas";
import React from "react";
import ReactDOM from "react-dom";
ReactDOM.render(
<Bananas.App
api="http://localhost:8000/api"
pages={route => import(`./pages/${route}`)}
/>,
document.getElementById("root")
);
Settings
| Property | Type | Default | Choices | | :-- | :-- | :-- | :-- | | api | String, Object | Required | | | pages | Function | Required | | | title | String | Bananas | | | logo | Function, String, Boolean | true | | | branding | String | Bananas | | | version | String | v1.0.0 | | | theme | Object | [django-bananas/themes].default (light) | | | pageTheme | Object | undefined | | | nav | Object, Boolean | {"home": ..., "bananas.me:list": ...} | | | layout | String | horizontal | horizontal, vertical | | permanent | Boolean | false | | | collapsed | Boolean | false | | | dense | Boolean | false | | | editableSettings | Boolean | false | | | loginForm | Function | undefined | | | logLevel | String, Object | WARN | INFO, DEBUG, WARN, ERROR, OFF | | prefix | String | "" | | | customizeContext | Function | undefined | | | container | Function | React.Fragment | |
api
Base API URL.
<Bananas.App
// ...
api="http://localhost:8000/api"
/>
Alternatively, you can pass an object of extra swagger-js options. For example, you could add a custom header:
<Bananas.App
// ...
api={{
url: "http://localhost:8000/api",
requestInterceptor: request => {
request.headers.Authorization = "secret";
return request;
},
}}
/>
pages
A function that dynamically imports pages. A page file should export default
a React component to render for the given route.
route => import(`./pages/${route}`);
Make sure that the directory containing your page files exists (even if it’s empty)! (./pages/
in the above example.) Otherwise your build tool might throw an error.
title
Sets trailing part of the document title: <current page title> | My Admin-App Title
.
logo
Use boolean false
to not render a logo, or true
to show the default Bananas logo. Use a string for an image URL or a function/component for full control.
<Bananas.App
// ...
logo={true | false}
logo={"https://foo.bar/logo.svg"}
logo={<MyLogo />}
/>
branding & version
Shown in the navigation header next to the logo.
theme & pageTheme
theme
and pageTheme
are Material UI theme objects, either partially or fully created. pageTheme
is only needed if you want a specific theme for the page area, other than the navigation, boot and login screen.
<Bananas.App
// ...
theme={themes.dark}
pageTheme={themes.light}
/>
nav
The nav
setting lets you define the order of items in the navigation, as well as icons for each item. It is a mapping between navigation endpoints (operation-id) and icons, or an array of navigation endpoints if you want to define order but not icons. Items not mentioned in the mapping or array are put last in alphabetical order, with a fallback icon (if needed).
<Bananas.App
// ...
nav={{
// "home": MyCustomDashboardIcon,
// "bananas.me:list": MyCustomUserIcon,
"example.user:list": PeopleIcon,
}}
/>
layout
Defines location of the app navigation. Use horizontal
layout for a side drawer, or vertical
for a top bar.
permanent & collapsed
The permanent
and collapsed
settings is only applicable for horizontal
layout. Permanent makes the drawer non-collapsable, and collapsable defines the initial state of the drawer.
dense
Set dense={true}
for smaller fonts/icons in the navigation.
loginForm
Set loginForm
to a react component if you need a custom login form other than the built-in default form/endpoint.
logLevel
Global log level:
<Bananas.App
// ...
logLevel="DEBUG",
/>
Log level per application label:
<Bananas.App
// ...
logLevel={{
bananas: "WARN",
myapp: "DEBUG",
}}
/>
prefix
Prefix sets the base url for the router. Use this if the admin app is mounted on a sub-path, i.e. /bananas/
.
customizeContext
A function that receives the standard AdminContext
and returns a new context object.
container
A function (React component) that resides under the AdminContext but above pages. Useful for wrapping the entire app in a custom context so data can persist between pages.
<Bananas.App
// ...
container={MyCustomContainer}
/>
Browser support
The code shipped to npm uses modern JavaScript, supported natively by all evergreen browsers. If you need deeper browser support, you need to configure your build system to transpile and polyfill node_modules/
code.
If you use Create React App, which runs Babel on code from npm packages, you can get IE11 support by adding the following to your main entrypoint:
import "react-app-polyfill/ie11";
import "react-app-polyfill/stable";
Example app
This repo contains an example app in the app/
folder.
Set up and start the backend: django-bananas.
Copy the sample settings:
cp app/src/_bananas.settings.js app/src/bananas.settings.js
You can then play around with different settings in
bananas.settings.js
.Start the example app:
docker-compose up -d
Alternatively, you could run outside docker:
npm ci npm start
(If you develop on this package, you need to run npm ci
and run tests outside docker. See package.json.)