Members
(static) VERSION :string
The current version of the SDK, i.e. 3.30.0
.
- Source:
Methods
(static) create(options, callbackopt) → {void}
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
Creation options: Properties
|
|||||||||||||
callback |
callback |
<optional> |
The second argument, |
- Source:
Examples
braintree.hostedFields.create({
client: clientInstance,
styles: {
'input': {
'font-size': '16pt',
'color': '#3A3A3A'
},
'.number': {
'font-family': 'monospace'
},
'.valid': {
'color': 'green'
}
},
fields: {
number: {
selector: '#card-number'
},
cvv: {
selector: '#cvv',
placeholder: '•••'
},
expirationDate: {
selector: '#expiration-date',
type: 'month'
}
}
}, callback);
braintree.hostedFields.create({
client: clientInstance,
styles: {
'input': {
// other styles
direction: 'rtl'
},
},
fields: {
number: {
selector: '#card-number',
// Credit card formatting is not currently supported
// with RTL languages, so we need to turn it off for the number input
formatInput: false
},
cvv: {
selector: '#cvv',
placeholder: '•••'
},
expirationDate: {
selector: '#expiration-date',
type: 'month'
}
}
}, callback);
var storedCreditCardInformation = {
// get this info from your server
// with a payment method lookup
month: '09',
year: '2017'
};
braintree.hostedFields.create({
client: clientInstance,
fields: {
expirationMonth: {
selector: '#expiration-month',
prefill: storedCreditCardInformation.month
},
expirationMonth: {
selector: '#expiration-year',
prefill: storedCreditCardInformation.year
}
}
}, callback);
(static) supportsInputFormatting() → {Boolean}
Returns false if input formatting will be automatically disabled due to browser incompatibility. Otherwise, returns true. For a list of unsupported browsers, go here.
- Source:
Example
var canFormat = braintree.hostedFields.supportsInputFormatting();
var fields = {
number: {
selector: '#card-number'
},
cvv: {
selector: '#cvv'
}
};
if (canFormat) {
fields.expirationDate = {
selection: '#expiration-date'
};
functionToCreateAndInsertExpirationDateDivToForm();
} else {
fields.expirationMonth = {
selection: '#expiration-month'
};
fields.expirationYear = {
selection: '#expiration-year'
};
functionToCreateAndInsertExpirationMonthAndYearDivsToForm();
}
braintree.hostedFields.create({
client: clientInstance,
styles: {
// Styles
},
fields: fields
}, callback);
Type Definitions
field :object
Fields used in fields options
Properties:
Name | Type | Attributes | Default | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selector |
string |
A CSS selector to find the container where the hosted field will be inserted. |
||||||||||||
placeholder |
string |
<optional> |
Will be used as the |
|||||||||||
type |
string |
<optional> |
Will be used as the |
|||||||||||
formatInput |
boolean |
<optional> |
true |
Enable or disable automatic formatting on this field. |
||||||||||
maskInput |
object | boolean |
<optional> |
false |
Enable or disable input masking when input is not focused. If set to Properties
|
||||||||||
select |
object | boolean |
<optional> |
If truthy, this field becomes a Properties
|
|||||||||||
maxlength |
number |
<optional> |
This option applies only to the CVV and postal code fields. Will be used as the |
|||||||||||
minlength |
number |
<optional> |
3 |
This option applies only to the cvv and postal code fields. Will be used as the |
||||||||||
prefill |
string |
<optional> |
A value to prefill the field with. For example, when creating an update card form, you can prefill the expiration date fields with the old expiration date data. |
- Source:
fieldOptions :object
An object that has field objects for each field. Used in create.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
number |
field |
<optional> |
A field for card number. |
expirationDate |
field |
<optional> |
A field for expiration date in |
expirationMonth |
field |
<optional> |
A field for expiration month in |
expirationYear |
field |
<optional> |
A field for expiration year in |
cvv |
field |
<optional> |
A field for 3 or 4 digit CVV or CID. |
postalCode |
field |
<optional> |
A field for postal or region code. |
- Source:
styleOptions :object
An object that represents CSS that will be applied in each hosted field. This object looks similar to CSS. Typically, these styles involve fonts (such as font-family
or color
).
These are the CSS properties that Hosted Fields supports. Any other CSS should be specified on your page and outside of any Braintree configuration. Trying to set unsupported properties will fail and put a warning in the console.
Supported CSS properties are:
appearance
color
direction
font-family
font-size-adjust
font-size
font-stretch
font-style
font-variant-alternates
font-variant-caps
font-variant-east-asian
font-variant-ligatures
font-variant-numeric
font-variant
font-weight
font
letter-spacing
line-height
opacity
outline
padding
text-shadow
transition
-moz-appearance
-moz-osx-font-smoothing
-moz-tap-highlight-color
-moz-transition
-webkit-appearance
-webkit-font-smoothing
-webkit-tap-highlight-color
-webkit-transition
- Source: