@@ -43,10 +43,15 @@ react from your app) you must be sure to:
4343How to customise the SDK
4444========================
4545
46- The matrix-react-sdk has been built to be heavily customisable - letting
47- developers both create new skins by extending/overriding the CSS and View
48- classes provided in the base skin, as well as entirely replacing components as
49- required.
46+ The matrix-react-sdk provides well-defined reusable UI components which may be
47+ customised/replaced by the developer to build into an app. A set of consistent
48+ UI components (View + CSS classes) is called a 'skin' - currently the SDK
49+ provides a very vanilla whitelabelled 'base skin'. In future the SDK could
50+ provide alternative skins (probably by extending the base skin) that provide more
51+ specific look and feels (e.g. "IRC-style", "Skype-style") etc. However, unlike
52+ Wordpress themes and similar, we don't normally expect app developers to define
53+ reusable skins and instead just go and incorporate their view customisations into
54+ their actual app.
5055
5156The SDK uses the 'atomic' design pattern as seen at http://patternlab.io to
5257encourage a very modular and reusable architecture, making it easy to
@@ -70,13 +75,6 @@ In practice this means:
7075 style organisms into a well-defined global look and feel
7176 * pages: specific instances of templates.
7277
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-
8078 Good separation between the components is maintained by adopting various best
8179 practices that anyone working with the SDK needs to be be aware of and uphold:
8280
0 commit comments