Documentation Index
Fetch the complete documentation index at: https://docs.coinlist.co/llms.txt
Use this file to discover all available pages before exploring further.
This changelog covers the
@coinlist-co/react SDK.Added
Client (@coinlist-co/react, @coinlist-co/react/client)
fetchOfferRequirements(offerId)onCoinListClient— returns requirements grouped by option ID (Record<OfferOptionId, Requirement[]>).fetchRequirementStatuses(offerId)onCoinListClient— returns the authenticated user’s status for each requirement.useCoinListRequirements(offerId)hook for loading requirements and statuses with aLOADING / CONTENT / ERRORstate machine.sandboxoption onClientConfig— whentrue, passessandbox=trueto offers API calls so sandbox offers are included.- New exported types:
Requirement,RequirementId,RequirementType,RequirementStatusValue,RequirementStatusInfo,ParticipationsPaginationParams. - New exported enums/constants:
RequirementVariant,RequirementStatus,ChecklistStatus. - New hook types:
UseCoinListRequirementsResult,LoadRequirementsState,LoadRequirementsReason. fetchAllParticipations(offerId?)andfetchParticipationsPage(params)now accept an optionalofferIdto fetch participations for a specific offer.fetchParticipationsPagetakes the newParticipationsPaginationParamstype (superset ofPaginationParams) which carries theofferIdfield.
Fixed
Components
- Fixed missing dark mode CSS variables in Next.js projects — prebuilt styles now include the full set of design-system tokens so components render correctly under
darkclass orprefers-color-scheme: dark.
Added
Client (@coinlist-co/react, @coinlist-co/react/client)
fetchAllParticipations()onCoinListClientfor fetching all participations across pages.fetchParticipationsPage()onCoinListClientfor paginated participation fetching.fetchParticipation()onCoinListClientfor fetching a single participation by id.createParticipation()onCoinListClientfor creating a new participation.- New exported types:
Participation,ParticipationId,ParticipationStatus,CreateParticipationParams,Blockchain,WalletAddress.
Added
Client (@coinlist-co/react, @coinlist-co/react/client)
- Added support for passing
classNameandcontainerClassNameto<OffersGrid />,<OfferCard />, and<CoinListSignInCard />.
Fixed
Client (@coinlist-co/react, @coinlist-co/react/client)
- Re-export offer, offer detail, and pagination types from the package root and client core entry so you can type against
Offer,OfferDetail, pagination params, and related helpers without reaching into internal modules. - Export
BaseCoinListSignInCardandBaseCoinListSignInCardPropsfrom@coinlist-co/react/clientfor custom sign-in layouts built on the same primitives asCoinListSignInCard.
Added
Client (@coinlist-co/react/client)
fetchAllOffers(),fetchOffersPage(), andfetchOfferDetails()onCoinListClientfor fetching offers data.<OffersGrid />— batteries-included component that loads offers and displays them in a responsive grid, with<OfferCard />for each tile.useCoinListOffers()hook for loading offers when you want full control over layout instead of the grid.useCoinListOfferDetails()hook for a single offer’s details.useCompleteCoinListOAuth()hook to run the OAuth redirect callback once on mount.- Optional
authorizationPageUrlon client config so you can pointstartOAuth()at a non-production authorization page.
Added
Client (@coinlist-co/react/client)
CoinListProvideranduseCoinList()hook for React context-based SDK initialization.createCoinListClient(config)factory for manual or non-React usage.- OAuth 2.0 with PKCE via
startOAuth()andcompleteOAuth(). getAuthState()andlogout().
Server (@coinlist-co/react/server)
createCoinListServer(config)factory for BFF / Next.js API routes.completeOAuth(),accessToken()(auto-refreshing), andlogout().
Components
CoinListSignInCardandCoinListSignInButtonfor OAuth sign-in flows.RequirementsChecklist/RequirementItem— eligibility checklist with accordion UI.PoweredByCoinListattribution badge.- Prebuilt CSS — no
tailwindcsspeer dependency required.
Infrastructure
- Subpath exports:
@coinlist-co/react,@coinlist-co/react/client,@coinlist-co/react/server. - Requires React 18+.