skiptools / skiptools/skip

Request: Supporting document-based apps with DocumentGroup

Open
#360 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Swift
Stars
3.2k
Forks
106
Avg merge
6d 13h
Merged PRs (30d)
1

Description

I recently came across the project and wanted to give it a shot for my app, Alidade (https://alidade.dev), but I noticed there doesn't seem to be any support for document-based apps with DocumentGroup. I'd like to request for such functionality in the future, as it would enable a whole class of apps.

These types of apps can provide:

  • A document launch experience and browser to let users pick files they want to open, or create a new one
  • A document view for reading and writing documents
  • Support for common operations such as copy/paste, undo/redo, etc. via conformances to FileDocument and ReferenceFileDocument

More information on document-based apps: https://developer.apple.com/documentation/swiftui/documents

Some things to note:

  • DocumentGroup and related APIs like FileWrapper are somewhat of a black box, and there's additional metadata to consider/read from Info.plist.
  • From what I've lightly researched, document browsers don't seem to really exist on Android (unless I'm looking in the wrong places on the documentation), so a new view might need to be created for Android specifically.

(I've also kept note of this with alicerunsonfedora/mcmaps#18)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository files or tests are identified. Start with the linked SwiftUI documents documentation and review DocumentGroup, FileDocument, ReferenceFileDocument, and Info.plist requirements, then compare them with the project's Android architecture. Done would cover document launch and browsing, document views, and common document operations on the supported platforms.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, swift
Domain
mobile
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.