Skip to content

Commit df4c5c5

Browse files
committed
define skins
1 parent 15c93b6 commit df4c5c5

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ classes provided in the base skin, as well as entirely replacing components as
4949
required.
5050

5151
The SDK uses the 'atomic' design pattern as seen at http://patternlab.io to
52-
encourage a very modular and reusable architecture, making it as easy to
52+
encourage a very modular and reusable architecture, making it easy to
5353
customise and use UI widgets independently of the rest of the SDK and your app.
5454
In practice this means:
5555

@@ -70,6 +70,13 @@ In practice this means:
7070
style organisms into a well-defined global look and feel
7171
* pages: specific instances of templates.
7272

73+
* "Skins" refer to a suite of components (views and css) which define the look
74+
and feel of the Matrix UI used in the target app. We provide a 'base' skin
75+
in skins/base which provides generic plain UI for typical chat functions.
76+
To change the look and feel to embed the SDK into your own app, users can
77+
define a new skin which inherits from the base one, or override components
78+
in the app itself. TODO: spell out how.
79+
7380
Good separation between the components is maintained by adopting various best
7481
practices that anyone working with the SDK needs to be be aware of and uphold:
7582

@@ -121,4 +128,4 @@ In practice this means:
121128

122129
With all this in mind, here's how you go about skinning the react SDK UI
123130
components to embed a Matrix client into your app: TODO. For now, check out
124-
the examples and work it out for yourself...
131+
the examples and work it out for yourself...

0 commit comments

Comments
 (0)