summaryrefslogtreecommitdiff
path: root/plugins/Customizer/README.md
blob: 9ae17cdbe94de43bbcc5749a6d7e4a0fcdc283c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
## Checkout our latest project
[![](https://raw.githubusercontent.com/docpht/docpht/master/public/assets/img/logo.png)](https://github.com/docpht/docpht)

- With [DocPHT](https://github.com/docpht/docpht) you can take notes and quickly document anything and without the use of any database.
-----------
[![Latest release](https://img.shields.io/github/release/creecros/Customizer.svg)](https://github.com/creecros/Customizer/releases)
[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/creecros/Customizer/blob/master/LICENSE)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/creecros/Customizer/graphs/contributors)
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)]()
[![Downloads](https://img.shields.io/github/downloads/creecros/Customizer/total.svg)](https://github.com/creecros/Customizer/releases)

Donate to help keep this project maintained.
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SEGNEVQFXHXGW&source=url">
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" border="0" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" /></a>

**:star: If you use it, you should star it on Github!**
*It's the least you can do for all the work put into it!*

Customizer - it's like magic!
----------

## Author: [creecros](https://github.com/creecros)
### Other [Contributors](https://github.com/creecros/Customizer/graphs/contributors)

If you need a Logo and Favicon, try using this simple logo generator: https://creecros.github.io/simple_logo_gen/

:sparkles:	**Adds a settings panel Settings>Customizer:**

![image](https://user-images.githubusercontent.com/26339368/49309828-7fc47800-f4aa-11e8-809e-8cc9686a2a2d.png)

**GUI to customize...**

* [header logo](#header-logo-rainbow)
  * set header logo size
* [upper right corner Avatar Icon](#header-avatar-icon-boy)
  * set icon size
  * set border radius
* [task board Avatar Icon](#task-board-avatar-icon-girl)
  * set icon size
  * set border radius
* [customizable login screen](#fully-customizable-login-screen-gem)
  * [login logo](#login-logo-peach)
  * [login page background image url](#login-screen-background-image-dart)
  * login logo link
  * set login logo size
  * set login page background color
  * set login panel color
  * panel shadow adjustment (no shadow to heavy shadow with color adjustment)
  * panel border adjustment (no border to thick border with color adjustment)
  * add a [custom note panel](#login-screen-custom-note-book) on login screen
* [favicon](#favicon-beginner)
* theme management
  * can upload css files to add to theme selection
  * can remove themes from interface
  * can enable/disable user themes (i.e. one global theme for everyone, or users get to select their own theme)
  * admins can reset all users themes to default
* [theme selector](#includes-preset-themes-mega) with 7 preloaded themes
  * Github :octocat:
  * Galaxy :milky_way:
  * Breathe :partly_sunny:
  * Clemson <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/7/72/Clemson_Tigers_logo.svg/2000px-Clemson_Tigers_logo.svg.png" height="20">
  * Blueboard :blue_book:
  * Material :sparkles:
  * KindaDark :8ball:
* [theme creator](#theme-creator-notes)


**...to your site without any backend coding or config settings.**

**Want more customization? Take a look at [BlueTek](https://github.com/BlueTeck)'s [BoardCustomizer](https://github.com/BlueTeck/kanboard_plugin_boardcustomizer) plugin**

## Favicon :beginner:	

![image](https://user-images.githubusercontent.com/26339368/47174055-a43f0900-d2dd-11e8-9932-430e11b74fea.png)

## Header Logo :rainbow:

![image](https://user-images.githubusercontent.com/26339368/47369113-f9e62d80-d6b0-11e8-90e0-974c31b4b535.png)

## Header Avatar Icon :boy:

![image](https://user-images.githubusercontent.com/26339368/55774303-8bc8d380-5a62-11e9-8d59-6dc2a1c33387.png)

## Task Board Avatar Icon :girl:

![image](https://user-images.githubusercontent.com/26339368/59513842-ae73d000-8e89-11e9-94b5-ae27a0f8c651.png)

## Login Logo :peach:

![image](https://user-images.githubusercontent.com/26339368/48488290-622ab980-e7ee-11e8-8efd-58d7b834a02f.png)

## Fully Customizable Login Screen :gem:

![image](https://user-images.githubusercontent.com/26339368/48627714-44428d80-e983-11e8-8451-2e873572007a.png)

![image](https://user-images.githubusercontent.com/26339368/48627526-ca120900-e982-11e8-9870-fd469c553124.png)

## Login Screen Background Image :dart:

![image](https://user-images.githubusercontent.com/26339368/47959793-573c8180-dfc3-11e8-84bc-ab654f8c50b5.png)

## Login Screen Custom Note :book:

![image](https://user-images.githubusercontent.com/26339368/64443449-e6ad3800-d09f-11e9-8d77-49e05db75e89.png)

## Includes Preset Themes :mega:

![image](https://user-images.githubusercontent.com/26339368/48488078-f2b4ca00-e7ed-11e8-8d4b-37d5b51f374b.png)
![image](https://user-images.githubusercontent.com/26339368/48488101-ffd1b900-e7ed-11e8-8438-9ec7b91c98d9.png)
![image](https://user-images.githubusercontent.com/26339368/49310809-64a73780-f4ad-11e8-81e6-82852275199a.png)

:8ball: KindaDark 
   
<img src="https://i.imgur.com/Mw3DRBM.png" />   
  

## Theme Creator :notes:

![image](https://user-images.githubusercontent.com/26339368/49310587-aedbe900-f4ac-11e8-935f-e499c14eb830.png)

![image](https://user-images.githubusercontent.com/26339368/49310623-c024f580-f4ac-11e8-968e-a05762634b80.png)

## Considerations :smirk:

**Will probably not function fully with other CSS plugins that override templates related to layout or headers**

## Theme Plugins that support Customizer
   * https://github.com/kenlog/nebula :dash:
   * https://github.com/kenlog/Moon :waning_gibbous_moon:
   * https://github.com/aljawaid/KanboardCSS :computer:
   * https://github.com/kenlog/Essential

*Make pull request to add other theme support, must come from theme maintainer.*

## Future Enhancements :lollipop:

- [x] Custom Theme Creator with Color Pickers
- [x] Preloaded Theme Selector
- [x] Sizing options
- [x] Increasing Compatibility
- [x] Toggle switch to enable/disable cache for images related to Customizer sitewide