Vyuh

Appearance

Vyuh Plugin Content Provider Sanity ​

vyuh_plugin_content_provider_sanity on pub.dev

Sanity.io is the default CMS used by the Vyuh Framework. This provider allows you to fetch documents from a Sanity dataset using GROQ queries and render them using the Vyuh Framework.

Overview ​

This package bridges the Vyuh content plugin system with Sanity.io. It implements the ContentProvider interface, handling all communication with the Sanity backend including document fetching, route resolution, and content caching.

Internally, the provider uses the sanity_client on pub.dev for its configuration and makes connections to the Sanity CDN.

Key Features ​

  • Route fetching -- Resolves CMS routes to structured content for rendering
  • Document queries -- Execute GROQ queries and deserialize results to Dart types
  • Built-in caching -- Leverages vyuh_cache to reduce network calls
  • Image handling -- Optimized image URL generation via Sanity's image pipeline
  • Live preview -- Support for draft content and preview perspectives

Configuration ​

dart
import 'package:vyuh_plugin_content_provider_sanity/vyuh_plugin_content_provider_sanity.dart';

final contentProvider = SanityContentProvider.withConfig(
  config: SanityConfig(
    projectId: 'your-project-id',
    dataset: 'production',
    perspective: Perspective.previewDrafts,
    useCdn: false,
    token: 'your-token',
  ),
  cacheDuration: const Duration(seconds: 5),
);

Usage with Vyuh ​

Register the Sanity content provider as part of the plugin configuration:

dart
void main() {
  vyuh.runApp(
    plugins: PluginDescriptor(
      content: DefaultContentPlugin(
        provider: SanityContentProvider.withConfig(
          config: SanityConfig(
            projectId: 'your-project-id',
            dataset: 'production',
          ),
        ),
      ),
    ),
    features: () => [
      system.feature,
      // ... other features
    ],
  );
}

Dependencies ​

  • sanity_client -- Low-level Sanity API client
  • vyuh_core -- Core framework types
  • vyuh_cache -- Caching layer for content responses
  • cached_network_image -- Efficient image loading and caching