Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
matrix-react-sdk
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GitHub Mirror
Matrix.org
matrix-react-sdk
Commits
6c81a8d4
Commit
6c81a8d4
authored
Jul 7, 2015
by
David Baker
Browse files
Options
Downloads
Patches
Plain Diff
Add blurb on how to build a customised app.
parent
df4c5c58
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+20
-2
20 additions, 2 deletions
README.md
with
20 additions
and
2 deletions
README.md
+
20
−
2
View file @
6c81a8d4
...
@@ -127,5 +127,23 @@ In practice this means:
...
@@ -127,5 +127,23 @@ In practice this means:
of the modularity requirements it brings to the table.
of the modularity requirements it brings to the table.
With all this in mind, here's how you go about skinning the react SDK UI
With all this in mind, here's how you go about skinning the react SDK UI
components to embed a Matrix client into your app: TODO. For now, check out
components to embed a Matrix client into your app:
the examples and work it out for yourself...
*
Create a new NPM project. Be sure to directly depend on react, (otherwise
you can end up with two copies of react).
*
Create an index.js file that sets up react. Add require statements for
React, the ComponentBroker and matrix-react-sdk and a call to Render
the root React element as in the examples.
*
Create React classes for any custom components you wish to add. These
can be based off the files in
`views`
in the
`matrix-react-sdk`
package,
modifying the require() statement appropriately.
You only need to copy files you want to customise.
*
Add a ComponentBroker.set() call for each of your custom components. These
must come
*before*
`require("matrix-react-sdk")`
.
*
Add a way to build your project: we suggest copying the browserify calls
from the example projects, but you could use grunt or gulp.
*
Create an index.html file pulling in your compiled index.js file, the
CSS bundle from matrix-react-sdk.
For more specific detail on any of these steps, look at the
`custom`
example in
matrix-react-sdk/examples.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
sign in
to comment