App settings

These are the owner’s settings for your app on their profile: what it is called there, whether it appears at all, who may open it, and removing it. They are not your app’s internal preferences. If you use @cskn/ui, drop in <AppSettings />. Otherwise useAppSettings gives you the same behavior to render in your own design.

import { useAppSettings } from '@cskn/sdk';

function VisibilitySettings() {
  const s = useAppSettings();

  return (
    <section>
      <input
        value={s.values.displayName}
        placeholder={s.app?.name}
        onChange={(e) => s.setDisplayName(e.target.value)}
      />
      <select value={s.values.visibility} onChange={(e) => s.setVisibility(e.target.value as any)}>
        <option value="public">Everyone</option>
        <option value="followers">Followers</option>
        <option value="private">Only people I choose</option>
      </select>
      {s.pageUrl && <a href={s.pageUrl}>{s.pageUrl}</a>}
      <button onClick={s.save} disabled={!s.isDirty || s.isSaving}>Save</button>
    </section>
  );
}

Values

string

Name on the owner’s page. Empty means the app’s own name.

string

The owner’s description. Empty means the app’s own.

'public' | 'followers' | 'private'

Who may open the app on the owner’s page.

boolean

When false, the app and its widgets are hidden from the profile.

boolean

Whether visitors may comment.

string[]

User ids allowed in while visibility is private.

State

AppSettingsValues / boolean

The owner’s draft, and whether it has unsaved edits.

{ name, description, icon } | null

Your app’s own identity, for headings and placeholders.

string | null

The app’s address on the owner’s page, https://<username>.cskn.my/<slug>.

boolean

false when the app is not on the owner’s profile, in which case none of this applies.

GrantedUser[]

Profiles for values.grantedUsers, in order.

Actions

Action	Notes
`setDisplayName`, `setDescription`, `setVisibility`, `setShowInPortfolio`, `setAllowComments`	Edit the draft.
`addGrantedUser(username)`	Looks the user up, then adds them to the draft. Resolves `'added'`, `'not-found'`, `'duplicate'` or `'failed'`.
`removeGrantedUser(userId)`	Removes from the draft.
`save()`	Sends only the fields the owner changed, so it never overwrites edits made elsewhere, or settings your screen does not show. `saveError` is `'not-activated'` or `'failed'`.
`deactivate()`	Removes the app from the profile. Resolves `true` on success. Only the store can add it back.

Saving also refreshes the widget catalog and the profile’s widgets, because visibility decides who sees them. Lower level: useAppSettingsQuery, getAppSettings, saveAppSettings, lookupUserByUsername, deactivateApp, APP_VISIBILITIES.

Overview

Platform API

Native features

Profile integration

Reference

Values

State

Actions

​Values

​State

​Actions

Values

State

Actions