Metadata-Version: 2.4
Name: django-surface-theme
Version: 0.0.14
Summary: Open-source Surface template with improved functionality
Home-page: https://github.com/surface-security/django-surface-theme
Author: PPB - InfoSec Engineering
Author-email: surface@paddypowerbetfair.com
License: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.11
Classifier: Environment :: Web Environment
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django<6,>=3
Requires-Dist: django-jsoneditor<=0.2,>0.1
Dynamic: license-file
Dynamic: requires-dist

# django-surface-theme

Surface theme is built on top of [Django Dashboard Atlantis Dark](https://appseed.us/admin-dashboards/django-dashboard-atlantis-dark).

[![PyPI version](https://badge.fury.io/py/django-surface-theme.svg)](https://badge.fury.io/py/django-surface-theme)

## Surface Theme variables

Define custom title in `urls.py`:
```
admin.site.site_title = "Surface Security"
```

Define side menu navigation items by adding the following variable in `settings.py`:
```
SURFACE_MENU_ITEMS = [
    {'label': ('Organisation'), 'icon': 'fas fa-building', 'items':[
        {'name': 'auth.user'}
    ]},
    {'label': ('Organisation'), 'app_label': 'auth', 'icon': 'fas fa-building', 'items':[
        {'name': 'user', 'label': 'Custom Label'},
        {'url': 'https://example.com', 'url_blank': True, 'label': 'Custom URL'}
    ]},
]
```

Define home links and items by adding the following variable in `settings.py`:
```
SURFACE_LINKS_ITEMS = [
    {'label': ('Examples'), 'items':[
        {'url': 'https://example.com', 'url_blank': True, 'name': 'Example.com'}
    ]}
]
```
