SDK

Using the Dashboard

We built a dashboard to help you customize how your social modules will look like without having to spend hours tweaking some CSS codes. It can also be used to create your own contexts.

Styles

By navigating to the Styles section of the dashboard you will be able to create a new style to pick the colors you want your social components to be using. Each style will be a unique stream on Ceramic which will be used to reference your style in your app. Here is an example:

<Discussion theme="kjzl6cwe1jw149wbqi4g5wrcc7dynyidmz2bvokqxc3r90l1g6mhslqjtpehqac" />

In the above example, the theme value points to this Ceramic stream which is a style that was created with our Dashboard. When the modules load, it retrieves the style from Ceramic and store it locally.

Contexts

After creating your first project you will be able to create context within your project. A context can represent a specific part of your app where the Orbis social module will be used. Contexts can be moderated by the owners or moderators and can be gated using specific rules such as the ownership of a verifible credentials. Here are some examples:

<Discussion context="kjzl6cwe1jw14bisozx249bjt26nyiz1326ani4s8gnfklj0fbedyy8avb06tld" />

In the above example, the context value points to this Ceramic stream which is a context that was created with our Dashboard. This context has some specific accessRules which will gate the modules access to only users who performed at least one swap on Uniswap.

Dynamic contexts

Contexts can be used with extensions for more flexibility with the : separator, here is an example:

/** If you want to load only comments shared under a specific article in your blog */
<Discussion context="kjzl6cwe1jw14bisozx249bjt26nyiz1326ani4s8gnfklj0fbedyy8avb06tld:<ARTICLE_ID>" />

In this example the comments loaded in the feed will be only the comments left under the article while benefiting from the global access rules and moderation features of the context.

Next steps

Let's go deeper into each modules.