Logo
CryptPad
Documentation 2024.9.0

  • User Guide
    • CryptPad instances
    • User Account
      • Account types
        • Guest user
        • Logged in user
        • Premium user
      • Account management
        • Registration
        • Logging in
      • Notifications
      • Settings
        • Account
        • Security & Privacy
        • Appearance
        • CryptDrive
        • Cursor
        • Rich Text
        • Code
        • Kanban
        • Notifications
        • Subscription
    • Support
      • Existing tickets
      • New ticket
      • Debug data
        • Names
        • Identifiers
        • Keys
        • Quota
        • Web browser
        • Screen
        • Block location
        • Teams
    • Security
      • Trust Assumptions
      • Passwords for documents and folders
      • Verifying contacts
      • Self-destructing documents
      • Remote Disconnect
      • Remote Content
      • Known caveats
        • No unique usernames
        • Edit rights in teams
        • Access of former team members
    • CryptDrive
      • Display
      • Managing documents
        • Folders
        • Renaming
        • Deleting
      • History
      • Tags
      • Templates
    • Collaboration / Social
      • Profile
        • Personal profile
        • User profile
      • Calendar
        • Toolbar
        • Share & Access
      • Contacts
        • Add a contact
        • Manage contacts
        • Chat with contacts
      • Teams
        • Team Drive
        • Team members
        • Invite members
        • Roles and permissions
        • Administration
        • Chat
        • Administration tab
    • Share / Access
      • Share
        • Access rights
        • Sharing with contacts
        • Sharing a link
        • Embedding
        • Shared folders
      • Access
        • Access tab
        • Access List
        • Owners
    • Applications
      • General
        • New document
        • Saving
        • Make a copy
        • Document history
        • Snapshots
        • Properties
        • Users and chat
      • Rich Text
        • Toolbar
        • View settings
        • Editing
          • Headings
          • Paragraphs
        • Import/Export
        • Comments
      • Spreadsheet
        • Documentation
        • Toolbars
        • Undo and collaboration modes
        • History
        • Printing
        • Import/Export
      • Code / Markdown
        • Toolbar
        • Theme
        • Import/Export
        • Markdown
        • Images
        • Lightbox
      • Slides
        • Toolbar
        • Writing slides with Markdown
        • Theme
        • Import/Export
        • Images
        • Lightbox
      • Form
        • Roles
        • Editing a form
          • Utilities
          • Question types
          • Form Settings
          • Responses
          • Advanced use-cases
        • Import/Export
      • Kanban
        • Organisation
        • Columns
        • Cards
        • Card editor
        • Display
        • Import/Export
      • Diagram
        • Documentation
        • Toolbars
        • Import/Export
      • Whiteboard
        • Toolbar
        • Drawing
        • Paint mode
        • Select mode
        • Export
    • Accessibility
      • Feedback channels
      • Keyboard Shortcuts
        • General Shortcuts
        • Drive Shortcuts
        • Toolbar Shortcuts
  • Administrator Guide
    • Installation
      • Prerequisites
        • Domains
        • Hardware
        • Software
      • Install Cryptpad
        • Recommended
          • Dependencies
          • OnlyOffice (optional)
          • Configuration
          • Daemonization
          • Systemd
          • FreeBSD
        • Docker
        • Install OnlyOffice manually
      • Domains
      • Install and configure Nginx
      • Configure CryptPad
        • Setup your instance
        • Add other administrators
        • Configure support help-desk
        • Build static pages & Open Graph metadata
        • Change the server’s cryptography library (optional)
        • Diagnostics
        • Support
    • Instance customization
      • Application config
        • Restricting guest access
        • Links to Terms of Service, Privacy Policy and Imprint pages
        • Security Hardening
        • Dark theme switch
      • Look and feel
        • Open Graph preview images
      • Translations
    • Maintenance
      • Upgrading CryptPad
      • Database administration
        • Backup and migration
        • Advanced administration
    • Administration panel
      • General
        • Instance name
        • Instance description
        • Admin contact email
        • Hosting location
        • Flush HTTP Cache
      • Customize
        • Upload Logo
        • Accent color
      • Broadcast
        • Homepage notice
        • Maintenance
        • Survey
        • Broadcast Message
      • Security
        • Enable remote embedding
        • Mandatory Two-Factor Authentication
      • Applications
        • Instance applications
      • User Directory
        • Close registration
        • Invitation Links
        • User Directory
      • User Storage
        • Storage Limit
        • Apply a custom limit
        • Custom limits
      • Database
        • Account information
        • Document information
        • Login-block information
        • 2FA Recovery
      • Support
        • Initialize support
        • Manage support team
      • Statistics
      • Performance
        • Performance
        • Measure disk performance
        • Disk performance measurement window
      • Network
        • Validate instance configuration
        • Server telemetry
        • Statistical aggregation
        • List my instance in public directories
        • Consent to contact
        • Crowdfunding participation
        • Instance purpose
    • Help-desk
      • Inbox
        • Filter by tag
        • Premium tickets
        • Unanswered tickets
        • Answered tickets
        • Archived tickets
      • Closed
        • Filter by tag
        • Closed tickets
      • Search
      • New ticket
        • Open a ticket for a user
      • Settings
        • Answer anonymously
        • Disable notifications
        • Snippets
  • Developer Guide
    • Set up a development instance
      • Prerequisites
      • Installation
      • Configuration
      • Caching
      • Launching in development mode
    • Contribute Code
      • License
      • Git
        • Pull requests
        • Branches
        • Before contributing
    • Key elements in CryptPad
      • Zero-knowledge
        • What our server can see
      • Content Security Policy (CSP) and security
      • Customization
      • Code rules
      • Translation keys
    • Database
      • Key points
      • Understanding document URLs
      • Finding a document
    • Code
      • General information
        • Sandbox
        • 5-level structure
        • Encryption
        • Drive and "pins" log
          • Example
        • Registration, login and block
          • Example
        • Client-server communication (Netflux)
          • Server side
          • Client side
          • Example
      • Client
        • Client architecture
          • Worker
          • Outer
          • Inner
        • ChainPad and Listmap
          • ChainPad
          • Checkpoints
          • ChainPad with JavaScript objects
          • Chainpad-netflux
          • Chainpad-listmap
        • Translation keys
          • Usage
          • Structure
        • Framework
          • sframe-app-outer.js
          • sframe-app-framework.js
          • framework.less
        • Worker
          • async-store.js
          • “Store” commands
        • Outer
          • Communication between levels
          • Communication with inner
          • Communication with the worker
        • Inner
          • Workflow
          • metadata-manager
          • UI modules
    • Adding Translations
      • Getting started
      • Including your translation
      • Actually translating content
      • Verifying Your Translations
      • Deleting a translation
  • Frequently Asked Questions
    • Common Issues
      • List of extensions known to cause issues with CryptPad
    • I forgot my password
    • How to import/export my documents to/from another platform?
      • Import/export is not visible in the File menu
      • Rich text document import/export
      • Spreadsheets import/export
    • I cannot do X with a document I created
    • Can I use CryptPad on mobile?
      • Are you planning to make an app?
    • Can CryptPad sync documents to my local filesystem?
    • What is the relationship between CryptPad and OnlyOffice?
    • How Secure is CryptPad?
    • FAQ for cryptpad.fr
      • Can I pay for my subscription without a card?
      • Do you accept cryptocurrencies for subscriptions and donations?
      • Can you provide a Data processing Agreement (DPA)?
  • How to contribute
    • Spread the word
    • Report bugs
    • Contribute to the documentation
    • Translate CryptPad
      • Community translation program
        • Terms
    • Contribute to the code
    • Financial support
CryptPad
  • Index »
  • Developer Guide »
  • Code »
  • Client

Client¶

  • Client architecture
  • ChainPad and Listmap
  • Translation keys
  • Framework
  • Worker
  • Outer
  • Inner

© Copyright 2024, CryptPad Team.

Built with Sphinx using a modified RTD theme.
CryptPad flagship instance | GitHub repository for this documentation.