ShortKit Flutter SDK

Short-form video feed, player, and widget components for Flutter apps.

Requirements

Flutter 3.16+
iOS 16.0+
Android API 24+

Installation

dependencies:
  shortkit_flutter: ^0.2.14

Then run flutter pub get.

iOS Setup

No additional setup is required. The native ShortKitSDK XCFramework is bundled with the package.

Android Setup

No additional setup is required. The native ShortKit Android SDK is resolved automatically via Maven Central.

Usage

Initialize ShortKit

Wrap your app (or a subtree) with ShortKitProvider to initialize the SDK:

import 'package:shortkit_flutter/shortkit_flutter.dart';

ShortKitProvider(
  publishableKey: 'your-publishable-key',
  child: MyApp(),
)

Video Feed

Display a vertical short-form video feed:

ShortKitFeed(
  config: FeedConfig(
    height: FeedHeight.full,
  ),
)

Single Player

Embed a single video player:

ShortKitPlayer(
  config: PlayerConfig(
    contentId: 'your-content-id',
  ),
)

Embed a video widget:

ShortKitWidget(
  config: WidgetConfig(
    contentId: 'your-content-id',
  ),
)

Feed Controller

Control the feed programmatically:

final controller = ShortKitFeedController();

ShortKitFeed(
  controller: controller,
  config: FeedConfig(),
)

// Navigate programmatically
controller.goToNext();
controller.goToPrevious();

Documentation

For full documentation, visit shortkit.dev.

License

MIT