@golfguiders/types
v1.0.6
Published
TypeScript types for the GolfGuiders embeddable golf course widget
Maintainers
Readme
@golfguiders/types
TypeScript type definitions for the GolfGuiders embeddable GPS golf course widget. The canonical WidgetConfig interface lives here and is the single source of truth shared across all GolfGuiders SDK packages.
Used by:
@golfguiders/react— for React, Next.js, Remix, Gatsby, and other React-based web frameworks@golfguiders/react-native— for React Native (iOS & Android)
You typically don't need to install this directly — it's a transitive dependency of the wrapper packages.
Installation
npm install @golfguiders/typesUsage
import type { WidgetConfig } from '@golfguiders/types';
const config: WidgetConfig = {
apiKey: 'YOUR_API_KEY',
courseId: 'chambers-bay-123',
setFlyover: true,
};What's exported
| Export | Description |
|---|---|
| WidgetConfig | Full type signature of all widget configuration options (30+ flags) |
For the complete list of options, see the React wrapper docs.
License
MIT — see LICENSE.
Support
- Email: [email protected]
- Bug reports: [email protected]
Maintainer
Saeed Afzal — CTO, GolfGuiders, Inc.
