이 페이지는
@whop/elements@1.10.0 및 @whop/elements-react@1.10.0을 다룹니다.v1.0.0부터 지원.
Playground
예시 데이터로 엘리먼트를 조합해 보세요. 컨트롤을 조작하고, 엘리먼트를 추가 및 배치하고, 이벤트가 실시간으로 발생하는 것을 확인할 수 있습니다:옵션
다음 옵션을whop.dashboard.create({ … })에 전달하거나, React에서는 <Dashboard>의 props로 전달합니다.
이 핸들 아래의 모든 화면이 데이터를 읽는 데 사용하는 범위 지정 토큰입니다. 서버에서
POST /api/v1/access_tokens로 핸들 전체에 사용할 토큰 하나를 발급하고, 만료되기 전에 update({ accessToken })로 새 토큰을 설정하세요. 결제를 읽으려면 payment:basic:read가 필요합니다. 구매자 이메일에는 추가로 member:email:read, 고객 여정에는 member:basic:read, 배송 추적 열에는 shipment:basic:read, 결제의 상품 및 플랜 이름에는 access_pass:basic:read와 plan:basic:read가 필요합니다. 배너에는 payout:account:read가 필요하고, 작업 표시줄에서 인증을 시작하려면 identity:write가 필요합니다. 생략하면 사용자 자신의 세션으로 읽으며, 이는 동일 출처에서만 응답합니다.이 화면들이 레코드를 읽을 계정 또는 사용자 ID입니다. 계정 ID에는
biz_ 접두사가 붙습니다. 사용자 ID에는 user_ 접두사가 붙으며, 사용자 자신의 처리해야 할 작업만 읽을 수 있고 결제는 없습니다.이 그룹 엘리먼트의 시각적 사용자 지정입니다. 전역
WhopElements({ appearance })보다 우선합니다. update({ appearance })로 실시간 변경할 수 있습니다.이 그룹 엘리먼트 UI 텍스트의 로케일입니다. 앱에 빌드된 로케일 중 하나로 설정하면 전역 구성보다 우선합니다. 그 외의 값은 기본 로케일로 대체됩니다.
이벤트
생성 옵션 또는 React props로 콜백을 전달합니다.onLoadingChange
그룹의 로딩 상태가 변경될 때 실행됩니다. 마운트된 엘리먼트 중 하나라도 로딩 중이면 값은 true입니다.
메서드
whop.dashboard.create({ … }) 또는 useDashboard()에서 받은 Dashboard 핸들에서 호출합니다.
update
마운트된 모든 엘리먼트에 새 핸들 옵션을 병합합니다. React에서는 대신 네임스페이스 props를 변경하세요.
매개변수
destroy
이 핸들이 생성한 모든 엘리먼트와 하위 컨트롤러를 제거하고, 컨트롤러 프레임을 제거하며, 구독을 해제합니다. 여러 번 호출해도 되지만, 제거된 핸들은 다른 모든 호출을 거부합니다. 다시 시작하려면 새 핸들을 생성하세요. React는 프로바이더가 언마운트될 때 그룹을 자동으로 제거합니다.
엘리먼트
이 그룹이 마운트하는 엘리먼트입니다. 각각 별도 페이지가 있습니다:RequiredActionsElement
Whop 잔액 대시보드에 표시되는 처리해야 할 작업 배너(신원 인증, 입금, 세금 등)를 API가 반환하는 순서대로 표시합니다. 처리할 작업이 없는 계정은 아무것도 렌더링하지 않으므로 엘리먼트를 레이아웃에 계속 배치해 둘 수 있습니다. 문구는 API에서 제공됩니다. Verify를 누르면 호스팅된 신원 인증 세션을 시작하고 해당 페이지로 이동합니다. Add money는
depositRequested를 보고하고 그대로 머무르므로, 호스트가 자체 입금 흐름(예: wallet 컨트롤러의 deposit 엘리먼트)을 마운트합니다. 그 외 모든 버튼은 작업 자체의 링크를 따릅니다. Dashboard 핸들의 accessToken으로 데이터를 읽으며, payout:account:read가 필요하고 인증을 시작하려면 identity:write도 필요합니다. 읽기에 실패하면 오류 대신 아무것도 렌더링하지 않습니다. 배너가 다른 사람의 페이지에서 가장 눈에 띄는 요소가 되어서는 안 되기 때문입니다.VerificationElement
계정 소유자에게 신원 인증을 요청하는 배너로, 인증이 완료되지 않은 동안에만 표시됩니다. 이미 인증한 계정은 아무것도 렌더링하지 않으므로 엘리먼트를 레이아웃에 계속 배치해 둘 수 있습니다. 헤드라인과 상태 메시지는 API에서 제공되며, 계정 소유자에게 인증 시작을 안내할 때는 더 짧은 설명이 사용됩니다. 따라서 계정의 실제 상태를 반영합니다. 인증을 시작하지 않은 계정에는 카드와 지급을 활성화하도록 안내하고, 검토 중인 계정에는 대기 중으로 표시하며, 실패했거나 플래그가 지정된 계정에는 그 사실을 알립니다. 버튼을 누르면
verificationRequested를 보고하고 그대로 머무르므로, 호스트가 자체 인증(예: verifications 컨트롤러의 kyc 엘리먼트)을 마운트합니다. Dashboard 핸들의 accessToken으로 데이터를 읽으며, payout:account:read가 필요합니다. 읽기에 실패하면 오류 대신 아무것도 렌더링하지 않습니다. 안내 배너가 페이지에서 가장 눈에 띄는 요소가 되어서는 안 되기 때문입니다.PaymentsTableElement
상태 카드, 검색, 필터, 정렬, 행 선택, CSV 내보내기, 열 설정, 페이지네이션을 갖춘 대시보드 결제 테이블입니다. 완전한 건수를 계산하고 로컬에서 필터링하기 위해 모든 결제 페이지를 읽으므로, 결제 내역이 많지 않은 계정에 적합합니다. 고객 세부 정보와 환불은 이벤트를 통해 애플리케이션에 전달됩니다.
PaymentDetailElement
대시보드의 금액 내역, 활동, 고객, 세부 정보, 고객 여정을 포함한 결제 세부 정보 페이지입니다. 각 섹션은 숨길 수 있습니다. payment:basic:read로 데이터를 읽으며, 고객 이메일에는 member:email:read, 여정에는 member:basic:read가 필요합니다. 작업 이벤트를 통해 애플리케이션이 변경 사항을 확인하고 승인할 수 있으며, 이 엘리먼트는 결제를 직접 환불, 재시도 또는 무효화하지 않습니다.

