Skip to main content

API Overview

shared-features exposes its API through six subpath entry points, all re-exported from the root so import { ... } from 'shared-features' always works. This page is the complete map; each section links to a detailed reference.

Entry points​

Import pathWhat it exports
shared-featuresEverything (init + config + re-exports below)
shared-features/componentsAd, notification, and profile components
shared-features/hooksAll React hooks
shared-features/servicesFirestore service functions (read + admin)
shared-features/typesAll TypeScript types/interfaces
shared-features/notificationsNotification event registry + templating

Initialization & config​

From the root entry:

  • initSharedFeatures(config) — initialize the package.
  • getConfig(), isInitialized() — read config / readiness.
  • getSharedFeaturesApp(), getSharedFeaturesDb(), getSharedFeaturesAuth(), getDeviceId() — underlying Firebase handles + device id.

See Initialization.

Hooks​

  • Campaigns: useCampaigns, useCampaign, useOneTimeAdModal, useUpdateAdModal
  • Broadcasts: useBroadcasts, useBannerBroadcasts, useModalBroadcasts, useToastBroadcasts, useBellBroadcasts, useSingleBroadcast, useAnnouncementModal
  • Feature flags: useFeatureFlags, useFeature, useFeatureGate, useFeatureFlagsSubscription, useSharedFeaturesOperational
  • Common features: useContactInfo, useDeveloperInfo, useAddressInfo, useSocialLinks, usePaymentOptions, useServices, useSkills, useTestimonials, useProjects, useProject

See Hooks.

Components​

  • Ads: AdPanel, AdSlider, AdModal, AdUpdateModal, AdBanner, AdCarousel, TopbarAdBanner (+ small/large variant components and getSmallPanelVariant / getLargePanelVariant)
  • Notifications: BroadcastBanner, AnnouncementModal
  • Common: ContactCard, DeveloperCard, SocialLinksBar, AddressCard, SkillsDisplay, TestimonialsGrid, ServicesGrid, FooterSection

See Components.

Services​

Read services (campaigns, analytics, broadcasts, feature flags, common features) and admin services (broadcast/template management, common-feature writes). See Services.

Notification events​

interpolate, interpolateWithFormatters, extractVariables, validateContext, defaultFormatters, the event registry (eventRegistry, STANDARD_EVENTS, getEventDefinition, registerCustomEvent, …), the standard template sets, and useNotificationEvents. See the Notification Events guide.

Types​

Every public interface — config, campaigns, broadcasts, feature flags, common features — is exported from shared-features/types. See Types.