GithubHelp home page GithubHelp logo

checkout-payment's Introduction

First of all (even before the block's name), its README.md should contain the following sentence at the very beginning:

=� Use this project, [contribute](https://github.com/{OrganizationName/{AppName}) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).

BLOCK NAME

Under the block's name, you should explain the topic, giving a brief description of the block's functionality in a store.

Next, add media (either an image of a GIF) with the rendered block, so that users can better understand how the block works in practice.

Media Placeholder

Configuration

In this section, you first must add the primary instructions that will allow users to use the block in their store, such as adding the block's app as a dependency in the manifest.json and declaring the block itself in a given template.

Next, add the block's props table:

Prop name Type Description Default value
XXXXX XXXXXX XXXXXXXX XXXXXX

Remember to also showcase any necessary disclaimer related to the block in this section, such as the different behavior it may display during its configuration.

Modus Operandi (not mandatory)

There are scenarios in which a block can behave differently in a store, according to how it was added to the catalog, for example. It's crucial to go through these behavioral changes in this section, allowing users to fully understand the practical application of the block in their store.

If you feel compelled to give further details about the block, such as it's relationship with the VTEX admin, don't hesitate to use this section.

Customization

The first thing that should be present in this section is the sentence below, showing users the recipe pertaining to CSS customization in blocks:

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

Thereafter, you should add a single column table with the available CSS handles for that block:

CSS Handles
paymentListContainer
savedCreditCardOption
newCreditCardOption
bankInvoiceOption
creditCardContainer
extraDataContainer
selectedPaymentLabel
creditCardExtraDataMessage
documentFieldSectionContainer
documentFieldContainer
billingAddressSectionContainer
billingAddressFormContainer
reviewPurchaseButtonContainer
reviewPurchaseButtonLabel

If there are none, add the following sentence instead:

The component still doesn't have CSS Handles for its specific customization.


Check out some documentation models that are already live:

Upcoming documentation:

checkout-payment's People

Contributors

arturpimentel avatar camilavcoutinho avatar jeffersontuc avatar kaisermann avatar lucasecdb avatar marcoskwkm avatar paul0vinicius avatar pedromtec avatar vwraposo avatar wdsrocha avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.