Menu
Commenze

Home

  • Getting Started

  • Installation

    Single Sign On (SSO)

    Signing in with SSO

    Signing out with SSO

  • Components Available

    Overview

    CommentSection

    Comment

    MinimizedComment

    Notification

Getting Started

Installing Commenze on your site

Installing Commenze is super simple. All you need is access to your websites code (you don't need to know how to code).

  1. 1. Add your site to Commenze

  2. 2. Follow the steps found here: Installing Commenze

Single Sign On (SSO)

SSO allows you to join Commenze with your custom user authentication.

To setup SSO with Commenze, you first need to add the Commenze code to each page you want a Commenze comment section on (step 3 above).

Signing in with SSO

To sign your users into a Commenze comment section simply invoke the following function after your user is signed into your system (don't invoke this when a user clicks your sign in button, do it after they have signed in):

commenzeSignIn(email, username, expiresIn)

Where the 3 parameters are:

email

- Required: The users email address


username

- Required: The users username (can be email if no username)


expiresIn

- Required: The amount of time the user will be logged in for in seconds


When choosing the expiresIn parameter, its good practice to make the user signed into Commenze for the same amount of time that they will be signed into your site. This is normally done through cookies.

Signing out with SSO

To sign your users out of a Commenze comment section you simply invoke the commenzeSignOut function when your user clicks your sign out button:

commenzeSignOut(email, username, expiresIn)

Components Available

Overview

With Commenze you have the ability to fully customize the look and feel of your comment section with some basic HTML and CSS. There are 4 main areas that you have control over:

CommentSection

- The entire comment section.


Comment

- A single comment/reply


MinimizedComment

- A comment that has been hidden/minimized by the user


Notification

- A users notification


Below you can see each in more detail.

CommentSection

Go to CommentSection documentation

CommentSection is how the entire comment section fits together. This is where you will be doing most of the styling for your custom theme.

Example Root Comment Style

Comment

Go to Comment documentation

The Comment component allows you to change the design and layout of single user Comment and its replies. Below is a simple example of what can be made:

Example Comment Style

MinimizedComment

Go to MinimizedComment documentation

MinimizedComment is how a single Comment looks when a user chooses to hide it.

Example Minimized Comment Style

Notification

Go to Notification documentation

Notification is responsible for showing users their notifications - such as another user replying to them. Below is an example of Notification along with the User Section:

Example Notification Style