В данном issue будут описаны предложения/исследования фичи кастомизации сторисов.

Сначала нужно определиться с необходимыми вьюхами у сториса. Для этого, ниже приведены иерархия вьюх в уже готовых лэйаутах.

• Сторис StoryFragment:
• Прогресс бар сториса (StoriesProgressView)
• Кнопка закрытия (ImageView/Button)
• Фрейм истории (StoryFrameView)

Фрейм сториса StoryFrameView:

• Картинку фрейма (ImageView)
• Контент фрейма (StoryFrameContentView)
• Прогресс бар загрузки фрейма (ProgressBar)
• Лэйаут ошибки (View) - кнопка перезагрузки, обязателен коллбек onRefresh

Контент фрейма StoryFrameContentView:

• Заголовок (TextView)
• Подзаголовок (TextView)
• Подробное описание (TextView)
• Кнопка действия (Button) - должен быть onClick

Следовательно, у сториса следующие основные элементы:

• Прогресс бар
• Картинка фрейма
• Текст фрейма (заголовок, подзаголовок, подробнее)
• Кнопка фрейма (обработка юрла по клику)
• Вью ошибки

Нужно добавить возможность замены имеющихся лэйаутов сторисов/фреймов/контента на свой собственный. Другой вопрос - как вставить собственные лэйауты в StoryFragment. Как вариант, можно передавать в конструктор StoryFragment указанные выше вьюхи. К примеру:

class StoryFragment : Fragment(), StoryListener {
    companion object {
        fun newInstance(story: Story, views: StoryViews): Fragment {
            ...
            return StoryFragment()
        }
    }
}

// Все основные элементы сториса
data class StoryViews(
    val progressBar: StoriesProgressView,
    val image: ImageView,
    val title: TextView,
    val subTitle: TextView,
    val description: TextView,
    val button: Button?,
    val errorView: View
)

Довольно простой способ, но тогда не получится управлять расположением элементов. По-хорошему, надо передавать именно R.layout.my_layout, но тогда, скорее всего, придется проверять наличие всех элементов в рантайме и выкидывать эксепшн при отсутствии.

Если ничего не пропускаю, реализация коллбэков типа нажатия кнопки сторисов уже реализована (добавлять кастомизацию и для этого было бы еще труднее), поэтому надо сначала решить с вьюхами.

Следующий вопрос - когда добавлять кастомные вьюхи. StoryFragment создается в FragmentAdapter-е, так что, скорее всего, вьюхи/лэйаут надо передать именно в него.

В итоге, нужно подумать о следующих моментах:

1. Как добавлять кастомные вьюхи - передавать инстансы в конструктор или передавать лэйаут? Во втором случае, как создать контракт о необходимых вью?
2. Когда совершить замену вьюх на кастомные? Скорее всего, передачу можно делать при инициализации либы, а эти вьюхи/лэйаут будут передаваться при создании фрагмента (в fragment adapter).
3. Надо определиться с максимальным минимумом необходимых вьюх. Потенциально, могут не понадобиться заголовки сторисов, соответственно, и в лэйауте вьюхи с текстом требовать не надо.

Сделал реализацию кастомных фреймов сторисов, схема такая: В активити сторисов, которая наследуется от StoriesBaseActivity, надо оверрайднуть createStoriesFragment:

class CustomStoriesActivity : StoriesBaseActivity() {
    override val createStoriesFragment: ((Story) -> StoryFragment) = { story ->
        CustomStoryFragment.newInstance(story)
    }
}

Уже в фрагменте указываем кастомную вьюху:

class CustomStoryFragment : StoryFragment() {
    companion object {
        fun newInstance(story: Story): StoryFragment =
            CustomStoryFragment().addStoryToArguments(story)
    }

    override fun createStoryFrameView(context: Context): BaseStoryFrameView =
        CustomStoryFrameView(context)
}

Важный момент по поводу newInstance, пришлось сделать аналогично обязательным параметрам в StoriesBaseActivity, где если не вызываем метод компаньона у родительского класса с передачей аргумента, то выбрасывается соответствующий эксепшн.

Наконец, сама кастомная вьюха фрейма:

class CustomStoryFrameView(context: Context) : BaseStoryFrameView(context) {

    private val binding = ViewCustomStoryFrameBinding.inflate(LayoutInflater.from(context)).apply {
        addView(root)
    }

    override fun onFrameSet(frame: StoryFrame) {
        binding.textTitle.text = frame.content.header1

        binding.image.setImageWithGlide(
            imageUrl = frame.imageUrl,
            onReady = { listener?.onLoaded() },
            onFailed = { binding.textError.isVisible = true }
        )
    }
}

onFrameSet - это коллбэк метод, вызываемый при задании нового фрейма, в нем нужно обновлять фрейм.

Описанный выше код взят из примера, который так же есть в этом ПР-е.

В итоге получилось средней сложности, но все равно хотелось бы идеального мира, где можно было бы просто передать в конструктор/билдер кастомную вьюху...

Вышло не очень юзер-френдли, но настройка статуса "просмотрено" делается через передачу аргумента во фрагмент:

class CustomStoryFragment : StoryFragment() {
    companion object {
        fun newInstance(story: Story): StoryFragment =
            CustomStoryFragment().addStoryToArguments(story, StoryIsSeenWhen.TWO)
    }