Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
UIKIT will allow some parts of the component to be replaceable with your own component.
Loading...
UIKIT allows the default behaviour to be overridden by custom logic.
Loading...
Loading...
Loading...
Loading...
There are many components that you can use and integrate into your existing application.
Amity UIKit provides already built UI elements on single page. You can change the appearance, such as colour and typography, in the global settings. However, the UIKit does not allow you to replace these small components with other views. In addition, you cannot modify the view hierarchy inside the page.
This component consists of two components; My community and Global feed components.
Create a view controller
In case you want to replace any of our default view, we provide view maker handlers in order to replace by custom view.
This component consists of three components; Recommend community, Top trending community, and Categories components.
Method
Description
myCommunityPreviewViewMaker
If you set this handler to the view controller, my community view will be replaced by the view passed through this block.
globalFeedViewMaker
If you set this handler to the view controller, global feed view will be replaced by the view passed through this block.
Feature
Description
My Community list
User can scroll horizontally to see a list of up to eight communities that the user has joined sorted in alphabetical order.
Navigation to Community profile page
When a user selects an community item, the user is navigated to Community Profile page
Navigation to My community page
When a user selects the arrow, the user is navigated to My community page
Feature
Description
Global feed
User can scroll vertically to see a list of posts from the global feed.
Method
Description
myCommunityPreviewViewMaker
If you set this handler to the view controller, my community view will be replaced by the view passed through this block.
Feature | Description |
Category list | User can see up to eight categories sorted in alphabetical order. |
Navigation to Category detail page |
Navigation to Category list |
Feature | Description |
Recommended Community list | User can scroll horizontally to see up to four recommended communities. |
Navigation to Community profile |
Feature | Description |
Top trending Community list | User can see up to five top trending communities. |
Navigation to Community profile |
When a user clicks on a category item , the user is navigated to .
When a user selects the arrow, the user is navigated to
When a user selects a community item , the user is navigated to
When a user selects a community item , the user is navigated to
Feature
Description
My community list
User can scroll vertically to see a list of communities that the user has joined sorted in alphabetical order.
Community search
User can search for community by name
Community creation
User can click on + button , to open Community Creation page
Feature | Description |
Community creation | User can create a community by filling the required fields and tapping the Create community button |
Parameter | Description |
viewType | enums to determine what the view type should be
consist of |
Feature | Description |
Community list by category | User can see a list of all communities that belong to a category sorted in alphabetical order. |
Navigation to Community Profile page |
When a user selects a community item, the user is navigated to
Feature
Description
Community profile update
User can update the information such as avatar, community name, description, categories etc for this community. Profile will be updated upon tapping save button.
Feature | Description |
Leave community | User can leave the viewing community by click on leave community button |
edit community profile page(moderator user) |
Close community(moderator user) | User can see and perform close community option if the user is the moderator. |
Community member page |
Community Notification setting |
User can see and access to if the user is the moderator.
User can access to
User can see the notification setting status and can access to the
Feature
Description
Category list
User can see a list of all categories sorted in alphabetical order.
Navigation to Category detail page
When a user selects a category item, the user is navigated to Category detail page
Feature
Description
toggle on/off notification community level setting
Users can choose to toggle on / off the notification setting for this specific community
Hide disable notification setting.
Users will not see push notifications that have been turned off
error state handle
When users try to Change the status of the community push notification setting and get an error from our back-end due to a failed attempt
This page provides a form for post creation.
Create a view controller
Parameter
EkoCommunityModel is a wrapper class of EkoCommunity which is a live object from EkoChat
Parameter
Description
postTarget
enums to determine where is the target feed
consist of myFeed
and community(EkoCommunityModel)
Feature | Description |
toggle on/off notification community level setting | Users can choose to toggle on / off the notification setting for this specific community |
Hide disable notification setting. | Users will not see push notification that have been turned off |
error state handle | when users try to change the status of the community push notification setting and get an error from our back-end due to a failed attempt |
No internet connection state | if users do not have a stable internet connection, the system will show the error as stated |
Feature
Description
toggle on/off notification community level setting
User can choose to toggle on / off the notification setting for this specific community
Hide disable notification setting.
User will not see the push notification that has been turn off.
error state handle
when use try to change the status of the community push notification setting but not success due to get error from Backend , we will show pop up and return the toggle state to before the change,
Feature
Description
Post content
User can view content of the post including reactions and comments.
Comment creation
User can create a comment by adding text to the compose bar and tapping Post button
This page provides a form to edit post content.
Feature
Description
Text editing
User can edit text content.
Image removal
User can remove images.
File removal
User can remove files.
Parameter
Description
postTarget
enums to determine where is the target feed
consist of myFeed
and community(EkoCommunityModel)
post
EkoPost is a live object from EkoChat
This page shows profile of a community including its own feed.
Feature
Description
Becoming a member
User can tap Join button to join a community
Post creation
User can tap the floating action button to open Post creation page
Community profile update
Creator can tap Edit profile button to open Community profile edit page
Feature | Description |
Community feed | User can scroll vertically to see a list of posts from a community feed |
Feature
Description
User profile update
User can update the information such as avatar, display name, and description. Profile will be updated upon tapping save button.
Feature
Description
User feed
User can scroll vertically to see a list of posts from a user feed
Feature
Description
Post creation on user's own feed
When a user selects My Timeline, UIKit will open Post Creation page with the user's own feed as the target.
Post creation on community feed
When a user selects a community, UIKit will open Post Creation page with the selected community.
Feature
Description
Member Selection
User can select a list of users
There are many pages and actions on AmityUIKit. Pages can be nested inside other and it would be hard for overriding events on the nested pages. In order to solve this problem, we provide EkoEventHandler
which is a behavior controller for actions that happens in UIKit.
Event
Parameter
Condition
communityDidTap
communityId
community avatar or community display name is tapped
userDidTap
userId
user avatar or user display name is tapped
editUserDidTap
userId
edit user button is tapped
postDidtap
postId
post or comment on social feed is tapped
editPostDidTap
postId
edit post button is tapped
channelDidTap
channelId
user channel list or user chat button is tapped
communityChannelDidTap
channelId
n/a
This settings allows you to control where a post can be shared to based on the post origin.
My feed - The post can be shared to my feed. This option will enable "Share to my timeline" menu when user clicks share button.
Public community - The post can be shared to any public community. This option will enable "Share to group" menu when user clicks share button.
Private community - The post can be shared to any private community. This option will enable "Share to group" menu when user clicks share button.
External - The post can be shared externally. This option will enable "More options" menu when user clicks share button.
Origin - The post can be shared within the community feed that it was created. If the post was created in either public or private community, this option will enable "Share to group" menu when user clicks share button.
My feed post - Posts that were created on my feed. By defaults, possible sharing targets are My feed, Public community, and Private community.
User feed post - Posts that were created on any other users' feed. By defaults, possible sharing targets are My feed, Public community, and Private community.
Public community feed post - Posts that were created on any public community. By defaults, possible sharing targets are My feed, Public community, and Private community.
Private community feed post - Posts that were created on any private community. By defaults, possible sharing target is Origin.
You can select a set of targets for each post origin.
Based on Post sharing settings, there are up to three post sharing events that can be emitted by UIKit.
Share to my timeline - an event emitted when a user clicks on "Share to my timeline" button.
Share to group - an event emitted when a user clicks on "Share to group" button.
Share externally - an event emitted when a user clicks "More options" button.
You can choose to intercept one or all of the events and apply your custom behaviour.
From v1.8 onwards, UIKit provides the capability for you to manage roles & permissions via the integration with SDK
Permissions
Description
Add user
Moderator user can add new member to the community.
Remove user
Moderator user can remove member from the community.
Assign Moderator role to other users
Moderator user can assign Moderator role to another member in the same community
Remove Moderator role from a Moderator user
Moderator user can remove Moderator role from another Moderator in the same community
Edit community
Moderator user can rename community, change community type as he see fit
Close community
Moderator user can close the community
Moderator badge
the "Moderator" badge shown on the post indicates it was created by a moderator user
When a user clicks on the user profile avatar at the post creator area, UIKit will open User profile page
However, you can intercept the event and define your own logic following the example below.
Subclass EkoEventHandler
and override its default functions.
2. Assign a class instance through a set function of UpstraUIKitManager
Feature
Description
Navigation to user profile page
User can view profile page by tapping on member list item
Report user
User can report members present in community
This page shows user profile information as well as user feed
Feature
Description
User Profile
User can view display name and description
Post creation
User can tap the floating action button to open Post creation page to create a post on user's own page
User profile update
User can tap Edit profile to open User profile edit page to update user's own profile