Compare commits

...

3 Commits

Author SHA1 Message Date
3189bad447 Update the guide on the sample 2025-03-15 10:32:42 +07:00
7ad3f98471 Giving a sample page 2025-03-15 04:14:02 +07:00
a16a31f46b Prime template 2025-03-13 23:22:23 +07:00
11 changed files with 576 additions and 1 deletions

View File

@ -1,7 +1,8 @@
from core import template
page = {
'public' :'pages/public'
'public' :'pages/public',
'sample' :'pages/sample'
}
static = [

View File

@ -9,7 +9,9 @@ from bottle import Bottle, route
from config import directory
import templates.plain.main as template_public
import templates.prime.main as template_sample_prime
import modules.public.home as public_home
import modules.sample.prime as sample_prime
app = Bottle()
@ -21,3 +23,13 @@ def index():
}
}
return public_home.main().html(params)
@app.route('/sample/prime')
def index():
params = {
"mako":{
"website" : template_sample_prime.main(directory.page["sample"], "prime")
}
}
return sample_prime.main().html(params)

125
modules/sample/prime.py Normal file
View File

@ -0,0 +1,125 @@
from mako.template import Template
from config import globalvar
class main:
def __init__(self):
pass
def html(self, params):
title = "CostaPy"
user_roles = [1,2] # A roles that user have
active_page = "Sample" # Current active page name
copyright = "Copyright (C) 2022 Dita Aji Pratama"
greeting = "A prime dashboard based on bootstrap 5"
menu_navbar = [
{
"name":"Home",
"target":"_self",
"href":"#",
"notification":0,
"roles":[1,2]
},
{
"name":"Customize",
"href":"#",
"target":"_self",
"notification":0,
"roles":[1,2]
},
{
"name":"Notification",
"href":"#",
"target":"_self",
"notification":1,
"roles":[1,2]
}
]
menu_profile = {
"picture": "https://ditaajipratama.net/img/no-profile-donut.png",
"name" : "Dita Aji Pratama",
"menu" : [
{
"name" :"Profile",
"href" :"/profile",
"target":"_self",
"roles" :[1,2]
},
{
"name" :"Settings",
"href" :"/settings",
"target":"_self",
"roles" :[1,2]
},
{
"name" :"Logout",
"href" :"/logout",
"target":"_self",
"roles" :[1,2,3]
}
]
}
menu_sidebar = [
{
"icon":"fa-solid fa-gauge",
"name":"Dashboard",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-users",
"name":"Users",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Items",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Analytic",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Reports",
"target":"_self",
"href":"#",
"roles":[1,2]
}
]
return Template(params["mako"]["website"]['index']).render(
title = title,
navbar = Template(params["mako"]["website"]['navbar']).render(
title = title,
menu = menu_navbar,
profile = menu_profile,
user_roles = user_roles,
active_page = active_page
),
sidebar = Template(params["mako"]["website"]['sidebar']).render(
menu = menu_sidebar,
user_roles = user_roles,
active_page = active_page
),
footer = Template(params["mako"]["website"]['footer']).render(
copyright = copyright,
),
container = Template(params["mako"]["website"]['container']).render(
greeting = greeting
)
)

174
pages/sample/prime.html Normal file
View File

@ -0,0 +1,174 @@
<div class="container">
<h1>CostaPy Template - Prime</h1>
<p>${greeting}</p>
<h2>Usage</h2>
<ul>
<li><p>Put the folder in your <code>templates</code> directory</p></li>
<li>
<p>Add to handler</p>
<code>
<pre>import templates.prime.main as template_dashboard
params["mako"] = {
"website" : template_dashboard.main("pages/dashboard", "users")
}</pre>
</code>
</li>
<li>
<p>Define a necessary variable on your modules</p>
<code>
<pre>title = "CostaPy"
user_roles = [1,2] # A roles that user have
active_page = "Users" # Current active page name
copyright = "Copyright (C) 2022 Dita Aji Pratama"
greeting = "Hello world"</pre>
</code>
</li>
<li>
<p>Define a navbar menu on your modules</p>
<code>
<pre>menu_navbar = [
{
"name":"Home",
"target":"_self",
"href":"#",
"notification":0,
"roles":[1,2]
},
{
"name":"Customize",
"href":"#",
"target":"_self",
"notification":0,
"roles":[1,2]
},
{
"name":"Notification",
"href":"#",
"target":"_self",
"notification":1,
"roles":[1,2]
}
]</pre>
</code>
</li>
<li>
<p>Define a profile menu on your modules</p>
<code>
<pre>menu_profile = {
"picture" : "https://ditaajipratama.net/img/no-profile-donut.png",
"name" : "Dita Aji Pratama",
"menu" : [
{
"name" :"Profile",
"href" :"/profile",
"target":"_self",
"roles":[1,2]
},
{
"name" :"Settings",
"href" :"/settings",
"target":"_self",
"roles":[1,2]
},
{
"name" :"Logout",
"href" :"/logout",
"target":"_self",
"roles":[1,2,3]
}
]
}</pre>
</code>
</li>
<li>
<p>Define a sidebar menu on your modules</p>
<code>
<pre>menu_sidebar = [
{
"icon":"fa-solid fa-gauge",
"name":"Dashboard",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-users",
"name":"Users",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Items",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Analytic",
"target":"_self",
"href":"#",
"roles":[1,2]
},
{
"icon":"fa-solid fa-book",
"name":"Reports",
"target":"_self",
"href":"#",
"roles":[1,2]
}
]</pre>
</code>
</li>
<li>
<p>Set a template on your modules</p>
<code>
<pre>return Template(params["mako"]["website"]['index']).render(
title = title,
navbar = Template(params["mako"]["website"]['navbar']).render(
title = title,
menu = menu_navbar,
profile = menu_profile,
user_roles = user_roles,
active_page = active_page
),
sidebar = Template(params["mako"]["website"]['sidebar']).render(
menu = menu_sidebar,
user_roles = user_roles,
active_page = active_page
),
footer = Template(params["mako"]["website"]['footer']).render(
copyright = copyright,
),
container = Template(params["mako"]["website"]['container']).render(
greeting = greeting
)
)</pre>
</code>
</li>
</ul>
<h2>License</h2>
<p>MIT License</p>
<p>Copyright (c) 2024 Dita Aji Pratama</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
</div>

View File

@ -0,0 +1,3 @@
<footer class="footer fixed-bottom" id="footer">
<p>${copyright}</p>
</footer>

View File

@ -0,0 +1,38 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>${title}</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
<link rel="stylesheet" href="/templates/prime/css/style.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css">
<link href="https://cdn.datatables.net/1.13.5/css/dataTables.bootstrap5.min.css" rel="stylesheet">
</head>
<body class="d-flex flex-column">
${navbar}
${sidebar}
<div class="content flex-grow-1" id="content">
${container}
</div>
${footer}
<button class="sidebar-toggle" id="sidebarToggle">
&#9776;<span>Menu</span>
</button>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
<script>
document.getElementById('sidebarToggle').addEventListener('click', function() {
var sidebar = document.getElementById('sidebar');
var content = document.getElementById('content');
var footer = document.getElementById('footer');
if (window.innerWidth <= 768) {
sidebar.classList.toggle('show');
} else {
sidebar.classList.toggle('minimized');
content.classList.toggle('full-width');
footer.classList.toggle('full-width');
}
});
</script>
</body>
</html>

View File

@ -0,0 +1,44 @@
<!-- Navbar -->
<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand" href="#">${title}</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
<ul class="navbar-nav ms-auto">
% for item in menu:
% if any(role in item['roles'] for role in user_roles):
<li class="nav-item">
<a class="nav-link ${'active' if item['name'] == active_page else ''}" href="${item['href']}" target="${item['target']}">
% if item['notification'] > 0:
${item['name']} <sup class="badge bg-danger">${item['notification']}</sup>
% else:
${item['name']}
% endif
</a>
</li>
% endif
% endfor
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle d-flex align-items-center" href="#" id="navbarDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
<img src="${profile['picture']}" alt="Profile" class="profile-image me-2">
${profile['name']}
</a>
<ul class="dropdown-menu dropdown-menu-end" aria-labelledby="navbarDropdown">
% for item in profile['menu']:
% if any(role in item['roles'] for role in user_roles):
<li>
<a class="dropdown-item ${'active' if item['name'] == active_page else ''}" href="${item['href']}" target="${item['target']}">
${item['name']}
</a>
</li>
% endif
% endfor
<!-- <li><hr class="dropdown-divider"></li> -->
</ul>
</li>
</ul>
</div>
</div>
</nav>

View File

@ -0,0 +1,16 @@
<!-- Sidebar -->
<div class="sidebar" id="sidebar">
<!-- <h5>Sidebar</h5> -->
<ul class="navbar-nav flex-column">
% for item in menu:
% if any(role in item['roles'] for role in user_roles):
<li class="nav-item">
<a class="nav-link text-white ${'active' if item['name'] == active_page else ''}" href="${item['href']}" target="${item['target']}">
<i class="${item['icon']} me-3"></i> ${item['name']}
</a>
</li>
% endif
% endfor
<!-- Add more items to test scrolling -->
</ul>
</div>

33
templates/prime/main.py Normal file
View File

@ -0,0 +1,33 @@
# MIT License
#
# Copyright (c) 2024 Dita Aji Pratama
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
from core import html
static = [
{
"route" : "/templates/prime/css/<filepath:re:.*\.(css|sass|css.map)>",
"root" : "./templates/prime/static/css"
},
{
"route" : "/templates/prime/img/<filepath:re:.*\.(jpg|jpeg|svg|png)>",
"root" : "./templates/prime/static/img"
}
]
def main(dir, page):
html_template = html.main.get_html("templates/prime/html")
html_page = html.main.get_html(dir)
return {
"index" : html_template [ "index.html" ],
"navbar" : html_template [ "navbar.html" ],
"sidebar" : html_template [ "sidebar.html" ],
"footer" : html_template [ "footer.html" ],
"container" : html_page [f"{page}.html" ]
}

View File

@ -0,0 +1,129 @@
body {
min-height: 100vh;
padding-top: 56px;
}
.navbar {
z-index: 1030; /* Ensure the navbar is above other elements */
}
.sidebar {
height: calc(100vh - 56px); /* 56px is the height of the navbar */
position: fixed;
top: 56px; /* Offset by the navbar height */
left: 0;
width: 250px;
background-color: #343a40;
color: white;
z-index: 1020; /* Lower than navbar to stay behind it */
transition: transform 0.3s ease-in-out;
overflow-y: auto; /* Make sidebar scrollable */
}
.sidebar::-webkit-scrollbar {
width: 6px;
}
.sidebar::-webkit-scrollbar-track {
background: #bbb;
border-radius: 3px;
margin-top: 5px;
margin-bottom: 30px;
}
.sidebar::-webkit-scrollbar-thumb {
background: #ddd;
border-radius: 3px;
margin: 12px 0;
}
.sidebar .navbar-nav {
padding-bottom: 80px;
}
.sidebar .navbar-nav .nav-item .active {
font-weight: bold;
}
.sidebar .navbar-nav .nav-item :hover {
background-color: rgba(0, 0, 0, 0.2); /* Darkens on hover */
}
.sidebar .navbar-nav .nav-item .nav-link {
padding-left: 20px;
}
.sidebar.minimized {
transform: translateX(-100%);
}
.content {
margin-left: 250px;
padding-bottom: 20px;
transition: margin-left 0.3s ease-in-out;
}
.content.full-width {
margin-left: 0;
}
.footer {
background-color: #f8f9fa;
padding-top: 5px;
text-align: center;
margin-left: 250px;
transition: margin-left 0.3s ease-in-out;
z-index: 1010;
}
.footer.full-width {
margin-left: 0;
}
.profile-image {
width: 20px;
height: 20px;
border-radius: 50%;
object-fit: cover;
}
.sidebar-toggle {
position: fixed;
bottom: 20px;
left: 20px;
background-color: #343a40;
color: white;
border: 1px solid #fff;
width: 100px;
height: 40px;
display: flex;
align-items: center;
justify-content: center;
cursor: pointer;
z-index: 1040; /* Above the sidebar and navbar */
padding: 5px;
border-radius: 8px; /* Rounded corners */
}
.sidebar-toggle span {
margin-left: 5px;
}
@media (max-width: 768px) {
.sidebar {
transform: translateX(-100%);
}
.sidebar.show {
transform: translateX(0);
}
.content {
margin-left: 0;
}
.footer {
width: 100%;
margin-left: 0;
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB