GitHub - mykolaharmash/notelet: Componente SwiftUI para exibir notas de lançamento ricas dentro de um aplicativo · GitHub

Importante

O Notelet lê a versão atual do aplicativo do pacote do seu aplicativo, especificamente a propriedade CFBundleShortVersionString. É a versão que você vê no Xcode na guia "General" para um alvo. Certifique-se de usar esta versão do aplicativo ao adicioná-la à lista notas; pode ser diferente da versão que você tem no App Store Connect.

Quando especificar a versão diretamente como version: .current, a folha de notas será exibida automaticamente quando o hierárquico da visualização renderizar. Você também pode disparar manualmente a folha via uma propriedade State.

struct ContentView: View {
    @State private var presentedVersion: NoteletPresentedVersion? = nil

    var body: some View {
        VStack {
            Text("Hello, world!")

            Button("Mostrar Notas de Lançamento") {
                presentedVersion = .current
            }
        }
        .noteletSheet(
            notes: notes,
            version: presentedVersion
        )
    }
}

Mostrar manualmente as notas para uma versão específica

Você também pode querer mostrar as notas de lançamento para versões do aplicativo diferentes da atual, por exemplo, para fornecer aos usuários acesso ao histórico de alterações nas configurações do aplicativo.

 .noteletSheet(
    notes: notes,
    version: .v("1.2.1")
)

A lista de notas de lançamento para cada versão do aplicativo é um array de structs NoteletVersionNotes. Cada struct especifica a version e items.

Você pode ter quantas notas quiser dentro de items para cada versão, elas serão organizadas em uma view de paginação com navegação usando o botão "Próximo" ou por meio de swipe.

O array pode ser uma constante global ou uma propriedade estática em alguma visualização do nível superior. Eu pessoalmente mantenho isso como uma constante global.

let RELEASE_NOTES: [NoteletVersionNotes] = [
    .init(
        version: "1.2.0",
        items: [ ... ] // <-- release notes go here
    )
]

A propriedade items para cada versão do aplicativo é um array de casos de enumeração NoteletVersionNoteItem. Existem três tipos de nota suportados:

• .list
• .media(kind: .image)
• .media(kind: .video)

Mostra um título e um conjunto de linhas, onde cada linha tem um SF Symbol, um título e uma descrição.

Este tipo de nota é ideal para mostrar ao usuário um resumo rápido da atualização.

let RELEASE_NOTES: [NoteletVersionNotes] = [
    .init(
        version: "1.2.0",\n        items: [
            .list(
                title: "What's new",\n                rows: [
                    .init(
                        symbolSystemName: "sparkles",\n                        title: "Polished details",\n                        description: "Small UI upgrades throughout the app."
                    )
                ]
            )
        ]
    )
]

Carrega e exibe uma imagem junto com um título e descrição. Ótimo para atualizações que precisam de mais contexto visual.

A imagem será envolta em um contêiner quadrado. Partes da imagem serão cortadas para preencher o contêiner se a proporção de aspecto for diferente de 1:1. É melhor usar imagens quadradas ou pelo menos ter o assunto principal no centro, para que não seja afetada pelo corte.

let RELEASE_NOTES: [NoteletVersionNotes] = [
    .init(
        version: "1.2.0",
        items: [
            .media(
                kind: .image,
                url: URL(string: "https://example.com/preview.jpg")!,
                title: "UI preview",
                description: "A quick look at the redesign."
            )
        ]
    )
]

Carrega e reproduz um vídeo junto com um título e descrição. Ótimo para casos em que uma funcionalidade precisa de mini-onboarding ou quando você quer destacá-la para o usuário.

Da mesma forma que as imagens, o vídeo será envolvido em um contêiner quadrado, então partes dele podem ser cortadas se tiver proporção não-quadrada.

let RELEASE_NOTES: [NoteletVersionNotes] = [
    .init(
        version: "1.2.0",
        items: [
            .media(
                kind: .video,
                url: URL(string: "https://example.com/demo.mp4")!,
                title: "Feature demo",
                description: "Veja o fluxo em ação."
            )
        ]
    )
]

.noteletSheet() tem um parâmetro opcional onDismiss semelhante ao padrão .sheet().