Terms of Service

Renders Frame's Terms of Service component — a short legal preamble with links to Frame's Privacy Policy, Terms of Service, and Platform Agreement, plus an optional accept button.

Construct via frame.createElement('termsOfService') or, when ToS is the only Frame surface on the page, via the lighter-weight Frame.createTermsOfService() helper.

EXAMPLE
import Frame from '@framepayments/frame-js';

const tos = await Frame.createTermsOfService('pk_sandbox_...');
tos.on('accepted', ({ token }) => {
  // submit token to your backend with the rest of the merchant signup
});
tos.mount('#tos-container');

Element options

backgroundColorstringoptional

Background color of the component.

buttonColorstringoptional

Color of the accept button.

customActionCopystringoptional

Custom label for the accept button (e.g. 'continue', 'agree').

fontFamilystringoptional

Font family for the component text.

fontSizestringoptional

Font size for the component text (CSS length, e.g. '14px').

fontWeightstring | numberoptional

Font weight for the component text (CSS value or numeric weight).

hideButtonbooleanoptional

Hide the built-in accept button and rely on your own submit control, which should call tos.accept() programmatically.

linkColorstringoptional

Color of the embedded Terms of Service links.

textColorstringoptional

Color of the body text.

Methods

Events