1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
import Markdown
/// A container directive that arranges content into a tab-based layout.
///
/// Create a new tab navigator by writing a `@TabNavigator` directive that contains child
/// `@Tab` directives.
///
/// ```md
/// @TabNavigator {
/// @Tab("Powers") {
/// 
/// }
///
/// @Tab("Exercise routines") {
/// 
/// }
///
/// @Tab("Hats") {
/// 
/// }
/// }
/// ```
///
/// ## Topics
///
/// - ``Tab``
public final class TabNavigator: Semantic, AutomaticDirectiveConvertible, MarkupContaining {
public static let introducedVersion = "5.8"
public let originalMarkup: BlockDirective
/// The tabs that make up this tab navigator.
@ChildDirective(requirements: .oneOrMore)
public private(set) var tabs: [Tab]
static var keyPaths: [String : AnyKeyPath] = [
"tabs" : \TabNavigator._tabs,
]
var childMarkup: [Markup] {
return tabs.flatMap(\.childMarkup)
}
@available(*, deprecated,
message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'."
)
init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
extension TabNavigator {
/// A container directive that holds general markup content describing an individual
/// tab within a tab-based layout.
///
/// To add a new tab to a ``TabNavigator``, add a `@Tab` directive within the content of the `@TabNavigator` directive.
public final class Tab: Semantic, AutomaticDirectiveConvertible, MarkupContaining {
public static let introducedVersion = "5.8"
public let originalMarkup: BlockDirective
/// The title that should identify the content in this tab when rendered.
@DirectiveArgumentWrapped(name: .unnamed)
public private(set) var title: String
/// The markup content in this tab.
@ChildMarkup(numberOfParagraphs: .oneOrMore, supportsStructure: true)
public private(set) var content: MarkupContainer
static var keyPaths: [String : AnyKeyPath] = [
"title" : \Tab._title,
"content" : \Tab._content,
]
var childMarkup: [Markup] {
return content.elements
}
@available(*, deprecated,
message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'."
)
init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
}
extension TabNavigator: RenderableDirectiveConvertible {
func render(with contentCompiler: inout RenderContentCompiler) -> [RenderContent] {
let renderedTabs = tabs.map { tab in
return RenderBlockContent.TabNavigator.Tab(
title: tab.title,
content: tab.content.elements.flatMap { markupElement in
return contentCompiler.visit(markupElement) as! [RenderBlockContent]
}
)
}
let renderedNavigator = RenderBlockContent.TabNavigator(tabs: renderedTabs)
return [RenderBlockContent.tabNavigator(renderedNavigator)]
}
}
|