{"id":14972221,"url":"https://github.com/adminfaces/admin-theme","last_synced_at":"2025-04-07T05:11:01.398Z","repository":{"id":88258115,"uuid":"78338714","full_name":"adminfaces/admin-theme","owner":"adminfaces","description":"Primefaces admin theme based on Admin LTE and Bootstrap","archived":false,"fork":false,"pushed_at":"2022-06-11T13:28:43.000Z","size":3266,"stargazers_count":145,"open_issues_count":9,"forks_count":64,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-30T21:14:25.756Z","etag":null,"topics":["adminlte","bootstrap3","jsf","material-design","primefaces","responsive"],"latest_commit_sha":null,"homepage":"https://adminfaces.github.io/site/docs/latest/#admin_theme","language":"Less","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adminfaces.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-08T11:28:35.000Z","updated_at":"2024-10-27T23:45:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"f3718132-b0d5-4636-a321-b407d5e794a6","html_url":"https://github.com/adminfaces/admin-theme","commit_stats":{"total_commits":715,"total_committers":9,"mean_commits":79.44444444444444,"dds":0.2447552447552448,"last_synced_commit":"f857cb4dc01a90fdca5c90ce9df2755ea1c81eb9"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adminfaces%2Fadmin-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adminfaces%2Fadmin-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adminfaces%2Fadmin-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adminfaces%2Fadmin-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adminfaces","download_url":"https://codeload.github.com/adminfaces/admin-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595335,"owners_count":20963943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adminlte","bootstrap3","jsf","material-design","primefaces","responsive"],"created_at":"2024-09-24T13:46:34.876Z","updated_at":"2025-04-07T05:11:01.377Z","avatar_url":"https://github.com/adminfaces.png","language":"Less","readme":"= Admin Theme\n:page-layout: base\n:toc: preamble\n:source-language: java\n:icons: font\n:linkattrs:\n:sectanchors:\n:sectlink:\n:numbered:\n:doctype: book\n:tip-caption: :bulb:\n:note-caption: :information_source:\n:important-caption: :heavy_exclamation_mark:\n:caution-caption: :fire:\n:warning-caption: :warning:\n\n[quote]\n____\nA PrimeFaces theme to `admin` them all!\n____\n\nimage:https://github.com/adminfaces/admin-theme/actions/workflows/ci.yml/badge.svg[Build Status, link=https://github.com/adminfaces/admin-theme/actions/workflows/ci.yml]\nimage:https://img.shields.io/maven-central/v/com.github.adminfaces/admin-theme.svg?label=Maven%20Central[\"Maven Central\",link=\"https://search.maven.org/search?q=g:com.github.adminfaces%20AND%20a:admin-theme\"]\nimage:https://badges.gitter.im/Join%20Chat.svg[link=\"https://gitter.im/adminfaces?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\"]\n\nThis project is a http://primefaces.org/themes[Primefaces^] `admin` theme based on https://almsaeedstudio.com/themes/AdminLTE/index2.html[Admin LTE^] and http://getbootstrap.com[Bootstrap^].\n\nimage:messages.png[link=\"https://github.com/adminfaces/admin-theme/blob/master/messages.png?raw=true\"]\n\n\n== Introduction\n\nThis theme is a css file containing Admin LTE and Bootstrap as well as customized Primefaces components to make them look like AdminLTE and Bootstrap.\n\n== Usage\n\n. Just add it to your application classpath:\n+\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c!--\u003cclassifier\u003edev\u003c/classifier\u003e uncompressed theme.css--\u003e\n\u003c/dependency\u003e\n----\n+\n. Add this context-param in your web.xml:\n\n----\n\u003ccontext-param\u003e\n    \u003cparam-name\u003eprimefaces.THEME\u003c/param-name\u003e\n    \u003cparam-value\u003eadmin\u003c/param-value\u003e\n\u003c/context-param\u003e\n----\n\nTIP: If you use https://github.com/adminfaces/admin-template[Admin Template^] there is no need to add admin-theme to your classpath neither the web.xml entry.\n\n== Architecture\n\nThe theme uses http://lesscss.org/[less^] as css pre-processor. Each PrimeFaces component has its own less file:\n\n.src/main/resources/less\n----\n├── admin-lte\n│    |\n│    ├── bootstrap \u003c1\u003e\n│    │\n│    ├── skins \u003c2\u003e\n│    │\n│    └── admin lte less files\n│\n├── primefaces-admin\n│    |\n│    ├─ components \u003c3\u003e\n│    │   |\n│    │   ├── accordeon.less\n│    │   │\n│    │   ├── autocomplete.less\n│    │   │\n│    │   └── etc...\n│    │\n│    ├─ theme.less \u003c4\u003e\n│    │\n     └─ variables.less\n----\n\u003c1\u003e Bootstrap variables and https://css-tricks.com/snippets/css/useful-css3-less-mixins/[mixins^] are used as reference in AdminLTE and admin theme less files\n\u003c2\u003e Built in skins\n\u003c3\u003e PrimeFaces components\n\u003c4\u003e Components and Admin-LTE less files are included in theme.less\n\nAfter compilation it will generate the theme.css with Admin-LTE, Bootstrap and Primefaces components.\n\nNOTE: Bootstrap.css (from src/META-INF/resources) is included in theme.less but can be removed via maven classifiers\n\nNOTE: Bootstrap less is not maintained in this project only it's mixins.\n\n\n== Theme classifiers\n\nThis project uses http://stackoverflow.com/questions/20909634/what-is-the-purpose-of-classifier-tag-in-maven[maven classifiers^] to offer multiple `faces` (pum intended) of Admin Theme. Below is the description of each classifier and how to use it.\n\n=== Default (no classifier)\nThe default theme comes `compressed`, with `Bootstrap (3.3.7)` embedded and uses `JSF resource handling` for loading images and web fonts.\n\n.Maven usage\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n----\n\n=== Dev classifier\n\nThe `dev` classifier will bring a theme.css *without minification*.\n\n.Maven usage\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cclassifier\u003edev\u003c/classifier\u003e\n\u003c/dependency\u003e\n----\n\n=== Without Bootstrap classifier\n\nThe `without-bootstrap` classifier will bring a theme.css *without bootstrap embedded* so it's up to the developer to provide Bootstrap within the application.\n\n.Maven usage\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cclassifier\u003ewithout-bootstrap\u003c/classifier\u003e\n\u003c/dependency\u003e\n----\n\n=== Without JSF classifier\n\nThe `without-jsf` classifier will bring a theme.css *without JSF resource handling* so the theme can be used on projects (derived from PrimeFaces) without JSF like Prime React, PrimeUI or PrimeNG.\n\n\n.Maven usage\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cclassifier\u003ewithout-jsf\u003c/classifier\u003e\n\u003c/dependency\u003e\n----\n\n=== No Fonts classifier\n\nSince `v1.0.0-RC16` web fonts such as `glyphicons` and `Source Sans Pro` were embedded inside the theme instead of being queried from a https://en.wikipedia.org/wiki/Content_delivery_network[CDN^]. \n\nThis makes the theme work offline or in environments with limited access to the internet but on the other hand results in a larger jar file, `~1MB` against `~200kb` when fonts are not in the theme.\n\nSo if you want a thinner theme you can use the *no-fonts* classifier:\n\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cclassifier\u003eno-fonts\u003c/classifier\u003e\n\u003c/dependency\u003e\n----\n\n\n== Avoiding theme caching\n\nWhenever the theme is updated to a new version in the project users may have to clear their browser caches to get the changes of the new theme.\nSometimes a theme update even introduces conflicts and only clearing browser cache fixes them.\n\nTo solve this issues you can use a theme classifier called *no-cache*:\n\n.pom.xml\n[source,xml]\n----\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.adminfaces\u003c/groupId\u003e\n    \u003cartifactId\u003eadmin-theme\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cclassifier\u003eno-cache\u003c/classifier\u003e\n\u003c/dependency\u003e\n----\n\nThis classifier *appends the theme version* to the name of theme so you need to *change the theme name* in `web.xml`:\n\n.web.xml\n[source,xml]\n----\n\u003ccontext-param\u003e\n    \u003cparam-name\u003eprimefaces.THEME\u003c/param-name\u003e\n    \u003cparam-value\u003eadmin-1.0.0\u003c/param-value\u003e\n\u003c/context-param\u003e\n----\n\nTIP: There is also a `no-cache-no-fonts` classifier combining both approaches.\n\n\n== Development\n\nTo get your hands dirty with admin theme it is recommended to use http://github.com/adminfaces/admin-designer[Admin Designer^] in combination with http://brackets.io/[Brackets] or any tool that `compile less` files to css on save.\n\nUsing designer, which is backed by http://wildfly-swarm.io/[Wildfly Swarm^], plus brackets will let you change the components less files and see the results instantly.\n\nNOTE: theme.less is already brackets aware so you just need to change any component less file, save it and see the results in Admin Designer.\n\n\n== Demo\n\n* https://github.com/adminfaces/admin-showcase[Admin Showcase^]\n\n* https://github.com/adminfaces/admin-starter[Admin Starter^]\n\n== Docs\n\nhttps://adminfaces.github.io/site/docs/latest/#admin_theme\n\n== Snapshot\n\nSnapshots are published to https://oss.sonatype.org/content/repositories/snapshots/com/github/adminfaces/[maven central^] on each commit, to use it just declare the repository below on your `pom.xml`:\n\n[source,xml]\n----\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003csnapshots/\u003e\n        \u003cid\u003esnapshots\u003c/id\u003e\n        \u003cname\u003elibs-snapshot\u003c/name\u003e\n        \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n----\n","funding_links":[],"categories":["Less"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadminfaces%2Fadmin-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadminfaces%2Fadmin-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadminfaces%2Fadmin-theme/lists"}