Skip to content

SoapboxSocial/minis.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

minis.js

TypeScript SDK to build Soapbox Minis.

CI npm version bundlephobia code style: prettier

Table of Contents

Install

$ npm install --save @soapboxsocial/minis.js

OR

$ yarn add @soapboxsocial/minis.js

API

Table of Contents

getUser

Get the current user of the Mini

Returns Promise<User>

getMembers

Get all of the users in a Soapbox room

Returns Promise<Array<User>>

getRoom

Get the details of the Soapbox room

Returns Promise<Room>

onClose

Function to handle when an app is closed, can be used for app state cleanup.

Parameters

Building a Mini

If you want to build your own Soapbox Mini or have an idea that you'd like to run past us, send us an email.

License

MIT License © Soaper Inc.