This commit is contained in:
Casey Wittrock 2025-10-19 22:57:58 -05:00
parent c5e27c0f70
commit 309925c191
28 changed files with 1757 additions and 4 deletions

5
.gitignore vendored
View File

@ -4,4 +4,7 @@
*.swp
tags
node_modules
__pycache__
__pycache__
*dist/
.vscode/

View File

@ -1,4 +1,4 @@
### Custom Ui
### Custom UI
Custom UI

40
custom_ui/commands.py Normal file
View File

@ -0,0 +1,40 @@
import click
import os
import subprocess
import frappe
from custom_ui.utils import create_module
@click.command("build-frontend")
def build_frontend():
app_package_path = frappe.get_app_path("custom_ui")
app_root = os.path.dirname(app_package_path)
candidates = [
os.path.join(app_root, 'frontend'),
os.path.join(app_package_path, 'frontend')
]
frontend_path = None
for p in candidates:
if os.path.exists(p):
frontend_path = p
break
if frontend_path:
click.echo("\n📦 Building frontend for custom_ui...\n")
try:
subprocess.check_call(["npm", "install"], cwd=frontend_path)
subprocess.check_call(["npm", "run", "build"], cwd=frontend_path)
click.echo("\n✅ Frontend build completed successfully.\n")
except subprocess.CalledProcessError as e:
click.echo(f"\n❌ Frontend build failed: {e}\n")
else:
frappe.log_error(message="No frontend directory found for custom_ui", title="Frontend Build Skipped")
click.echo(f"\n⚠️ Frontend directory does not exist. Skipping build. Path was {frontend_path}\n")
@click.command("create-module")
def create_module_command():
create_module()
click.echo("✅ Custom UI module created or already exists.")
commands = [build_frontend, create_module_command]

View File

@ -0,0 +1,8 @@
from frappe import _
def get_data():
return [{
"module_name": "Custom UI",
"type": "module",
"label": _("Custom UI")
}]

View File

View File

@ -0,0 +1,6 @@
<div id="custom-ui-app"></div>
{% if bundle_path %}
<script type="module" src="{{ bundle_path }}"></script>
{% else %}
<p style="color: red">Bundle path is not available.</p>
{% endif %}

View File

@ -0,0 +1,11 @@
frappe.pages["custom_ui"].on_page_load = function (wrapper) {
$(wrapper).html('<div id="custom-ui-app"></div>');
console.log("App root div created");
const script = document.createElement("script");
script.src = "/assets/custom_ui/dist/assets/custom_ui.bundle.js";
script.type = "module";
document.body.appendChild(script);
console.log("Custom UI script loaded:", script.src);
};

View File

@ -0,0 +1,10 @@
{
"name": "custom_ui",
"title": "Custom UI",
"doctype": "Page",
"module": "Custom UI",
"standard": "Yes",
"type": "Single",
"content": "",
"icon": "octicon octicon-screen-full"
}

View File

@ -0,0 +1,17 @@
import frappe
from custom_ui.utils import get_manifest
def get_context(context):
frappe.throw("Loading custom_ui context...")
print("Loading custom_ui context with manifest...")
manifest = get_manifest()
context.template = "custom_ui/custom_ui/page/custom_ui/custom_ui.html"
print("Manifest:", manifest)
if manifest:
js_file = manifest["src/main.js"]["file"]
context.bundle_path = f"/assets/custom_ui/dist/{js_file}"
else:
print("ERROR: Manifest is missing or invalid.")
frappe.log_error(message="Manifest file is missing or invalid for custom_ui", title="Context Load Failed")
context.bundle_path = ""

View File

@ -1,10 +1,31 @@
from . import commands
app_name = "custom_ui"
app_title = "Custom Ui"
app_title = "Custom UI"
app_publisher = "Shiloh Code LLC"
app_description = "Custom UI"
app_email = "casey@shilohcode.com"
app_license = "mit"
after_install = "custom_ui.install.after_install"
after_migrate = "custom_ui.install.after_migrate"
# on_session_creation = "custom_ui.utils.on_login_redirect"
# on_login = "custom_ui.utils.on_login_redirect"
# page_js = {
# "custom_ui": "custom_ui/custom_ui/page/custom_ui/custom_ui.js"
# }
# app_include_js = ["/assets/custom_ui/dist/assets/main.js"]
add_to_apps_screen = [
{
"name": "custom_ui",
"logo": "/assets/custom_ui/logo.png",
"title": "Custom UI",
"route": "/app/custom_ui",
# "has_permission": "custom_ui.api.permission.has_app_permission"
}
]
# Apps
# ------------------

46
custom_ui/install.py Normal file
View File

@ -0,0 +1,46 @@
import os
import subprocess
import frappe
from .utils import create_module
def after_install():
create_module()
build_frontend()
def after_migrate():
build_frontend()
def build_frontend():
app_package_path = frappe.get_app_path("custom_ui")
app_root = os.path.dirname(app_package_path)
candidates = [
os.path.join(app_root, "frontend"),
os.path.join(app_package_path, "frontend")
]
frontend_path = None
for p in candidates:
if os.path.exists(p):
frontend_path = p
break
if not frontend_path:
frappe.log_error(message="No frontend directory found for custom_ui", title="Frontend Build Skipped")
print(f"⚠️ Frontend directory does not exist. Skipping build. Path was {frontend_path}")
return
dist_path = os.path.join(app_root, "custom_ui", "public", "dist")
should_build = True
if os.path.exists(dist_path) and os.listdir(dist_path):
print(" Frontend already built. Skipping rebuild.")
should_build = False
if should_build:
print("\n📦 Building frontend for custom_ui...\n")
try:
subprocess.check_call(["npm", "install"], cwd=frontend_path)
subprocess.check_call(["npm", "run", "build"], cwd=frontend_path)
print("\n✅ Frontend build completed successfully.\n")
except subprocess.CalledProcessError as e:
frappe.log_error(message=str(e), title="Frontend Build Failed")
print(f"\n❌ Frontend build failed: {e}\n")

View File

@ -1 +1 @@
Custom Ui
Custom UI

View File

@ -0,0 +1,20 @@
frappe.pages["custom-ui"].on_page_load = async (wrapper) => {
const page = frappe.ui.make_app_page({
parent: wrapper,
title: "Custom UI",
single_column: true,
});
const $main = $(wrapper).find(".layout-main-section");
$main.empty();
const manifestUrl = "/assets/custom_ui/dist/.vite/manifest.json";
const manifest = await (await fetch(manifestUrl)).json();
const mainJs = `/assets/custom_ui/dist/${manifest["src/main.js"]["file"]}`;
const script = document.createElement("script");
script.type = "module";
script.src = mainJs;
document.body.appendChild(script);
};

37
custom_ui/utils.py Normal file
View File

@ -0,0 +1,37 @@
import frappe, os, json
def get_manifest():
app_path = frappe.get_app_path("custom_ui")
manifest_path = os.path.join(app_path, "custom_ui","public", "dist", ".vite", "manifest.json")
if not os.path.exists(manifest_path):
frappe.log_error(message="Manifest file not found for custom_ui", title="Manifest Load Failed")
return {}
with open(manifest_path) as f:
return json.load(f)
def create_module():
print("Creating Custom UI module if it does not exist...")
mod_name = "Custom UI"
if frappe.db.exists("Module Def", mod_name):
mod = frappe.get_doc("Module Def", mod_name)
mod.show_in_sidebar = 1 # make sure its visible
mod.save(ignore_permissions=True)
print(f"Module '{mod_name}' updated with show_in_sidebar=1")
else:
frappe.get_doc({
"doctype": "Module Def",
"module_name": mod_name,
"app_name": "custom_ui",
"color": "#1976d2",
"icon": "octicon octicon-code",
"show_in_sidebar": 1
}).insert(ignore_permissions=True)
print(f"Module '{mod_name}' created")
frappe.db.commit()
print("Custom UI module creation process completed.")
def on_login_redirect(login_manager):
frappe.local.response["type"] = "redirect"
frappe.local.response["location"] = "/app/custom-ui"

View File

24
frontend/.gitignore vendored Normal file
View File

@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
node_modules
dist
dist-ssr
*.local
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

5
frontend/README.md Normal file
View File

@ -0,0 +1,5 @@
# Vue 3 + Vite
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).

13
frontend/index.html Normal file
View File

@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>frontend</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.js"></script>
</body>
</html>

1289
frontend/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

18
frontend/package.json Normal file
View File

@ -0,0 +1,18 @@
{
"name": "frontend",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"vue": "^3.5.22"
},
"devDependencies": {
"@vitejs/plugin-vue": "^6.0.1",
"vite": "^7.1.7"
}
}

1
frontend/public/vite.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

After

Width:  |  Height:  |  Size: 1.5 KiB

30
frontend/src/App.vue Normal file
View File

@ -0,0 +1,30 @@
<script setup>
import HelloWorld from './components/HelloWorld.vue'
</script>
<template>
<div>
<a href="https://vite.dev" target="_blank">
<img src="/vite.svg" class="logo" alt="Vite logo" />
</a>
<a href="https://vuejs.org/" target="_blank">
<img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
</a>
</div>
<HelloWorld msg="Vite + Vue" />
</template>
<style scoped>
.logo {
height: 6em;
padding: 1.5em;
will-change: filter;
transition: filter 300ms;
}
.logo:hover {
filter: drop-shadow(0 0 2em #646cffaa);
}
.logo.vue:hover {
filter: drop-shadow(0 0 2em #42b883aa);
}
</style>

View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="37.07" height="36" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 198"><path fill="#41B883" d="M204.8 0H256L128 220.8L0 0h97.92L128 51.2L157.44 0h47.36Z"></path><path fill="#41B883" d="m0 0l128 220.8L256 0h-51.2L128 132.48L50.56 0H0Z"></path><path fill="#35495E" d="M50.56 0L128 133.12L204.8 0h-47.36L128 51.2L97.92 0H50.56Z"></path></svg>

After

Width:  |  Height:  |  Size: 496 B

View File

@ -0,0 +1,43 @@
<script setup>
import { ref } from 'vue'
defineProps({
msg: String,
})
const count = ref(0)
</script>
<template>
<h1>{{ msg }}</h1>
<div class="card">
<button type="button" @click="count++">count is {{ count }}</button>
<p>
Edit
<code>components/HelloWorld.vue</code> to test HMR
</p>
</div>
<p>
Check out
<a href="https://vuejs.org/guide/quick-start.html#local" target="_blank"
>create-vue</a
>, the official Vue + Vite starter
</p>
<p>
Learn more about IDE Support for Vue in the
<a
href="https://vuejs.org/guide/scaling-up/tooling.html#ide-support"
target="_blank"
>Vue Docs Scaling up Guide</a
>.
</p>
<p class="read-the-docs">Click on the Vite and Vue logos to learn more</p>
</template>
<style scoped>
.read-the-docs {
color: #888;
}
</style>

5
frontend/src/main.js Normal file
View File

@ -0,0 +1,5 @@
import { createApp } from "vue";
import "./style.css";
import App from "./App.vue";
createApp(App).mount("#custom-ui-app");

79
frontend/src/style.css Normal file
View File

@ -0,0 +1,79 @@
:root {
font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
line-height: 1.5;
font-weight: 400;
color-scheme: light dark;
color: rgba(255, 255, 255, 0.87);
background-color: #242424;
font-synthesis: none;
text-rendering: optimizeLegibility;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
a {
font-weight: 500;
color: #646cff;
text-decoration: inherit;
}
a:hover {
color: #535bf2;
}
body {
margin: 0;
display: flex;
place-items: center;
min-width: 320px;
min-height: 100vh;
}
h1 {
font-size: 3.2em;
line-height: 1.1;
}
button {
border-radius: 8px;
border: 1px solid transparent;
padding: 0.6em 1.2em;
font-size: 1em;
font-weight: 500;
font-family: inherit;
background-color: #1a1a1a;
cursor: pointer;
transition: border-color 0.25s;
}
button:hover {
border-color: #646cff;
}
button:focus,
button:focus-visible {
outline: 4px auto -webkit-focus-ring-color;
}
.card {
padding: 2em;
}
#app {
max-width: 1280px;
margin: 0 auto;
padding: 2rem;
text-align: center;
}
@media (prefers-color-scheme: light) {
:root {
color: #213547;
background-color: #ffffff;
}
a:hover {
color: #747bff;
}
button {
background-color: #f9f9f9;
}
}

26
frontend/vite.config.js Normal file
View File

@ -0,0 +1,26 @@
import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import { resolve } from "path";
// https://vite.dev/config/
export default defineConfig({
plugins: [vue()],
build: {
outDir: resolve(__dirname, "../custom_ui/public/dist"),
emptyOutDir: true,
manifest: true,
rollupOptions: {
output: {
input: resolve(__dirname, "src/main.js"),
entryFileNames: "assets/custom_ui.bundle.js",
chunkFileNames: "chunks/[name].js",
assetFileNames: "assets/[name].[ext]",
},
},
},
server: {
port: 5173,
strictPort: true,
},
base: "/assets/custom_ui/dist/",
});