mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-05-11 04:07:10 +00:00
Evgeny
035a2f954c
* ui: additional images, views for making connections and creating groups (#6750) * ios: setup for additional assets * ios build config * header * fix * update layout * more views with images * layout * layout * android images and view * fix path * fix desktop * fix desktop build * smaller image * layout * more layout * more kotlin views * group layout * padding * create group layout * more create group layout * layout * tweak layout * more tweak * config --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> * ios: connecting as part of onboarding (#6754) * ios: implementation of "connecting" cards * ios: revision * fix flip * fixes * fix frame * replace nav stack with tab view * rename * update gradient and card label material * fix gradient * debug * remove debug code * update card labels * card label layout * landscape cards * layout * safe area * less bold * debug landscape * refactor titles, back inline with title in landscape * remove ignoreSafeArea * remove extra padding * refactor * clean * layout spec added to plan --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> * android, desktop: connecting during onboarding - new cards (#6757) * android, desktop: connecting during onboarding - new cards * fix * change layout * fixes * fix * fix * layout * fix layout * animation * import * paddings * 350ms * font * fonts * layout * box * more layout * layout * simpler * hide toolbar heading in onboarding mode * simpler desktop layout * better desktop * revert desktop toolbar * bigger font, landscape * fix desktop * cap width * refactor, simplify * qr code scanner icon * use icon without assets * cleaner * fix * fix --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> * android, desktop: connect banner after onboarding (#6761) * android, desktop: connect banner after onboarding * improve * smaller button * bigger icon, same string * fallback gradients * improve build * simpler connect screens during onboarding * left-align * update strings * improve state machine * text, padding * strings * primary color for tap to paste link * fix race condition * fix loading race --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> * ios: banner and connect screens (#6767) * ios: banner and connect screens * fix * return nav * remove padding * refactor * refactor * refactor 2 * refactor 3 * refactor 4 * header * xcode files * improve * fix toolbar * toolbar 2 * no assets * no assets 2 * padding * android padding * simplify * layout * fix --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> * fix refreshable * text * fix toolbar color * rework address share logic * padding --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> Co-authored-by: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com>
115 lines
4.0 KiB
Markdown
115 lines
4.0 KiB
Markdown
# SimpleX Chat iOS app
|
|
|
|
This file provides guidance when working with code in this repository.
|
|
|
|
## iOS App Overview
|
|
|
|
The iOS app is a SwiftUI application that interfaces with the Haskell core library via FFI. It shares the SimpleXChat framework with two extensions: Notification Service Extension (NSE) for push notifications and Share Extension (SE) for sharing content from other apps.
|
|
|
|
## Build & Development
|
|
|
|
Open `SimpleX.xcodeproj` in Xcode. The project has five targets:
|
|
- **SimpleX (iOS)** - Main app (Bundle ID: `chat.simplex.app`)
|
|
- **SimpleXChat** - Framework containing FFI bridge and shared types
|
|
- **SimpleX NSE** - Notification Service Extension
|
|
- **SimpleX SE** - Share Extension
|
|
- **Tests iOS** - UI tests
|
|
|
|
Build and run via Xcode (Product > Build/Run). Tests run via Product > Test or:
|
|
```bash
|
|
xcodebuild test -scheme "SimpleX (iOS)" -destination 'platform=iOS Simulator,name=iPhone 15'
|
|
```
|
|
|
|
Deployment target: iOS 15.0+, Swift 5.0.
|
|
|
|
## Architecture
|
|
|
|
### Haskell Core Integration
|
|
|
|
The app calls the Haskell core library through C FFI defined in `SimpleXChat/SimpleX.h`:
|
|
- `chat_migrate_init_key()` - Initialize/migrate database
|
|
- `chat_send_cmd_retry()` - Send command to chat controller
|
|
- `chat_recv_msg_wait()` - Receive messages from controller
|
|
|
|
Swift wrappers in `SimpleXChat/API.swift`:
|
|
- `chatMigrateInit()` - Initialize chat controller
|
|
- `sendSimpleXCmd<R>()` - Send typed commands and parse responses
|
|
- `recvSimpleXMsg<R>()` - Receive typed messages
|
|
|
|
Haskell runtime initialization (`SimpleXChat/hs_init.c`) uses different memory configurations:
|
|
- Main app: 64MB heap
|
|
- NSE: 512KB heap (minimal footprint for background processing)
|
|
- SE: 1MB heap
|
|
|
|
Pre-compiled Haskell libraries are in `Libraries/{ios,mac,sim}/`.
|
|
|
|
### State Management
|
|
|
|
- **ChatModel** (`Shared/Model/ChatModel.swift`) - Main singleton `ObservableObject` for app-wide state (chat list, active chat, users)
|
|
- **ItemsModel** - Manages chat items within a selected chat (similar to Kotlin's ChatsContext)
|
|
- **AppTheme** - Theme management and customization
|
|
|
|
### App Structure
|
|
|
|
Entry point: `Shared/SimpleXApp.swift`
|
|
|
|
Key directories in `Shared/`:
|
|
- `Model/` - Data models and API layer (`ChatModel.swift`, `SimpleXAPI.swift`)
|
|
- `Views/` - SwiftUI views organized by feature:
|
|
- `ChatList/` - Chat list and user picker
|
|
- `Chat/` - Message display and composition
|
|
- `Call/` - VoIP call UI
|
|
- `UserSettings/` - App settings
|
|
- `LocalAuth/` - Passcode and biometric authentication
|
|
- `Database/` - Database initialization and migration
|
|
|
|
### Shared Data Between Targets
|
|
|
|
All three targets share data via App Group (`group.chat.simplex.app`):
|
|
- `SimpleXChat/AppGroup.swift` - GroupDefaults wrapper for typed shared preferences
|
|
- Keychain for sensitive data: `kcDatabasePassword`, `kcAppPassword`, `kcSelfDestructPassword`
|
|
|
|
### Key Types
|
|
|
|
Types are defined in `SimpleXChat/`:
|
|
- `ChatTypes.swift` - User, Chat, Message, Group types
|
|
- `APITypes.swift` - API request/response types
|
|
|
|
Commands follow `ChatCmdProtocol` (has `cmdString` property), sent as JSON through FFI.
|
|
|
|
## Localization
|
|
|
|
31 languages supported. Localization files in `SimpleX Localizations/`.
|
|
|
|
Workflow:
|
|
- `Product > Export Localizations` - Export XLIFF files
|
|
- `Product > Import Localizations` - Import updated translations
|
|
|
|
## SimpleX Assets
|
|
|
|
The app includes optional assets behind the `SIMPLEX_ASSETS` Swift compilation flag. Without setup, the app builds normally without them.
|
|
|
|
### Setup
|
|
|
|
Create `Local.xcconfig` (gitignored) in the `apps/ios/` directory:
|
|
```
|
|
SIMPLEX_ASSETS_DIR = /path/to/assets
|
|
SWIFT_ACTIVE_COMPILATION_CONDITIONS = $(inherited) SIMPLEX_ASSETS
|
|
```
|
|
|
|
The copy script (`scripts/ios/copy-assets.sh`) runs as a build phase on each build but exits immediately if `SIMPLEX_ASSETS` is not set.
|
|
|
|
### Updating assets
|
|
|
|
When source images change, regenerate resized images (requires ImageMagick):
|
|
```bash
|
|
cd path/to/assets && ./resize.sh
|
|
```
|
|
|
|
## Background Capabilities
|
|
|
|
Configured in Info.plist:
|
|
- Background modes: audio, fetch, remote-notification, voip
|
|
- URL scheme: `simplex://` for deep linking
|
|
- BGTaskScheduler: `chat.simplex.app.receive`
|