Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NexusUpdateProps

Hierarchy

  • NexusUpdateProps

Index

Properties

Properties

community

community: string

props

props: { about: string; description: string; flag_text: string; is_nsfw: boolean; lang: string; settings: { avatar_url: string; cover_url: string; default_view: "list" | "blog" | "grid" }; title: string }

Type declaration

  • about: string

    120 chars maximum

  • description: string

    a blob of markdown to describe purpose, enumerate rules, etc. (5000 chars)

  • flag_text: string

    custom text for reporting content

  • is_nsfw: boolean

    true if this community is 18+. UI to automatically tag all posts/comments nsfw

  • lang: string

    ISO 639-1 (en, fr, de)

  • settings: { avatar_url: string; cover_url: string; default_view: "list" | "blog" | "grid" }
    • avatar_url: string

      same format as account avatars; usually rendered as a circle

    • cover_url: string

      same format as account covers; used as header background image

    • default_view: "list" | "blog" | "grid"
  • title: string

    32 chars maximum

Generated using TypeDoc