Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modifying the theming.md file for better understanding #16806

Closed
wants to merge 5 commits into from
Closed

Modifying the theming.md file for better understanding #16806

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8539ff1
Modifying the theming.md file for better understanding
Ashray123 Mar 28, 2021
9207943
Updated docs/theming.md
Ashray123 Mar 28, 2021
fb66e65
Merge branch 'develop' of https://github.com/vector-im/element-web in…
Ashray123 Apr 26, 2021
906892d
modified theming.md
Ashray123 Apr 27, 2021
7cc76bc
modified theming.md file
Ashray123 Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/theming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Theming Element
============
CSS Based Themes
================

Themes are a very basic way of providing simple alternative look & feels to the
Element app via CSS & custom imagery.

They are *NOT* co be confused with 'skins', which describe apps which sit on top
They are *NOT* to be confused with 'skins', which describe apps which sit on top
of matrix-react-sdk - e.g. in theory Element itself is a react-sdk skin.
As of Jan 2017, skins are not fully supported; Element is the only available skin.

To define a theme for Element:
To define a css theme for Element:

1. Pick a name, e.g. `teal`. at time of writing we have `light` and `dark`.
2. Fork `src/skins/vector/css/themes/dark.scss` to be `teal.scss`
Expand All @@ -24,10 +24,10 @@ To define a theme for Element:
In future, the assets for a theme will probably be gathered together into a
single directory tree.

Custom Themes
=============
JSON Based Themes (Labs Feature):
==================================
Ashray123 marked this conversation as resolved.
Show resolved Hide resolved

Themes derived from the built in themes may also be defined in settings.
When [`feature_custom_themes`](https://github.com/vector-im/element-web/blob/master/docs/labs.md#custom-themes-feature_custom_themes) is enabled, JSON based themes derived from the built in themes may also be defined in settings.
Ashray123 marked this conversation as resolved.
Show resolved Hide resolved

To avoid name collisions, the internal name of a theme is
`custom-${theme.name}`. So if you want to set the custom theme below as the
Expand Down