README.md

Using FAStoryKit to implement an Instagram highlights alike

Provides an easy setup for displaying content like Instagram highlights. Can be used as an alternative onboarding process or just to simply communicate new things, campaigns, features etc to the users. There is a starter project implementation here

Feel free to check it out

Features

• Segmented progress bar to display the current progress of the stories embedded in the view controller.
• Long press to pause
• Tap to go forward / backward
• Swipe down to dismiss
• Story content implementation
• Automatically switch between different higlights with built in custom interactive transitions
• Built in support for handling url's within stories & displaying them in Safari
• Stories are configurable with a simple json cfg file & can be directly initiliazed from there making use of the Decodable
• Generic content backing template (see FAStoryContentTemplate) for future extensions. Currently UIImage and AVPlayer is supported as possible contents of a story but it's possible to subclass the generic template to create further content types.
• Custom container view for the highlights (see FAStoryView)
• Custom view controller that is able to display an array of stories (therefore [FAStory]) with next/previous/pause on touch down action support (see FAStoryViewController & FAStoryContainerVC)

Some previews

Configuring the FAStoryView in any parent view controller

• Configure the view in your viewController

storyView = FAStoryView(frame: .zero)     
storyView.backgroundColor = .clear
storyView.delegate = self
storyView.dataSource = self

• Implement the delegate & datasource protocols for configurations and display modifications

public protocol FAStoryDelegate: class {
    /// cell horizontal spacing
    var cellHorizontalSpacing: CGFloat {get}

    /// cell height
    var cellHeight: CGFloat {get}

    /// cell aspect ratio
    var cellAspectRatio: CGFloat {get}

    /// display name font
    var displayNameFont: UIFont {get}

    /// display name color
    var displayNameColor: UIColor {get}

    /// vertical cell padding
    func verticalCellPadding() -> CGFloat

    /// did select
    func didSelect(row: Int) -> Void 
}

• The datasource asks for the Stories to be displayed. Only thing that needs to be done is to return an array of the FAStory objects.

extension YourVC: FAStoryDataSource {
    func stories() -> [FAStory]? {
        return storyHandler.stories
    }
}

FAStoryViewController to display the contents of the story

Currently the framework supports UIImage and AVPlayer objects as the contents of the stories. Therefore images and videos can be displayed in any Story view.

To do that there is a dedicated ViewController that controls the rewind / next / previous features and that displays a progress indicator as well.

All it takes is to initialize the viewController, pass the FAStory object and present the view controller.

storyVc = FAStoryViewController()
storyVc.delegate = self
storyVc.story = _stories[idx]

storyVc.modalPresentationStyle = .overFullScreen
storyVc.modalPresentationCapturesStatusBarAppearance = true
storyVc.transitioningDelegate = self

present(storyVc, animated: true)

If you want to use the default auto-switching behaviour between story highlights, use FAStoryContainerVC instead. This brings the auto-switching both with next / previous taps on the screen and with a custom interactive transitioning.

storyVc = FAStoryViewController()
storyVc.delegate = self
storyVc.story = _stories[idx]

storyContainerVc = FAStoryContainer(storyController: storyVc)
storyContainerVc.modalPresentationStyle = .overFullScreen
storyContainerVc.modalPresentationCapturesStatusBarAppearance = true
storyContainerVc.transitioningDelegate = self

present(storyContainerVc, animated: true) 

Creating FAStory objects

FAStory by default conforms to the Decodable protocol. Therefore with a json file it's possible to initialize any. For example:

"stories": [{
        "name":"R",
        "contentNature":0,
        "previewAsset":"dog",
        "contents": 
            [
                {
                    "contentType":0,
                    "assetName":"doghd",
                    "externalURL":"",
                    "duration":10
                }
            ]
        },

        {
            "name":"E",
            "contentNature":0, 
            "previewAsset":"cat",
            "contents": 
                [
                    {
                        "contentType":0,
                        "assetName":"cathd",
                        "externalURL":"",
                        "duration":10
                    },
                    {
                        "contentType":0,
                        "assetName":"pandahd",
                        "externalURL":"",
                        "duration":10
                    }
                ]
            },
        {
            "name":"V",
            "contentNature":0, 
            "previewAsset":"panda",
            "contents": 
                [
                    {
                        "contentType":1,
                        "assetName":"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerBlazes.mp4",
                        "externalURL":"",
                        "duration":10
                    },
                    {
                        "contentType":0,
                        "assetName":"cathd",
                        "externalURL":"https://dinginkafa.com",
                        "duration":10
                    }
                ]
        },
        
        {
            "name":"O",
            "contentNature":0, 
            "previewAsset":"giraffe",
            "contents": 
                [
                    {
                        "contentType":0,
                        "assetName":"giraffehd",
                        "externalURL":"",
                        "duration":10
                    },
                    {
                        "contentType":0,
                        "assetName":"pandahd",
                        "externalURL":"",
                        "duration":10
                    }
                ]
            }
        ]
    }

and then:

/// create the built in stories
do {

    //
    // get the content from the config file
    //
    let data = try Data(contentsOf: Bundle.main.url(forResource: "Stories", withExtension: "json")!, options: [.mappedIfSafe])

    //
    // convert to json
    //
    guard let json = try JSONSerialization.jsonObject(with: data, options: [.mutableLeaves, .allowFragments]) as? NSDictionary else {return}

    //
    // extract the story data from the config
    //
    guard let _stories = json["stories"] as? [Any] else {return}

    //
    // go over all elements to initialize story objects
    // from each
    //
    for _story in _stories {
        let data = try JSONSerialization.data(withJSONObject: _story, options: [])

        let _story = try JSONDecoder().decode(FAStory.self, from: data)

        if self.stories == nil {
            self.stories = [_story]
        } else {
            self.stories?.append(_story)
        }
    }
} catch {
    print(error.localizedDescription)
}