Giter Club home page Giter Club logo

collapse-web-component's Introduction

collapse-web-component

A web components learning project. This web component creates a collapse element which has a label and a content section. If the user clicks on the label, the content will expand.

Installation:

To use this Web-Component you have to do 3 things:

  • Add the <template> and it contents to your HTML.
  • Load jQuery (a no jQery Version is planned in the future)
  • Load the collapse.js file <script src="collapse.js"></script>

Now you can use the <collapse-component> tag in your HTML.

Usage

Once you have completed the installation steps, you can add your collapse-component anywhere on your page: Wrap any html content you want to be collapsed in a span with the slot="collapse-content" and put it inside the custom element:

<collapse-component open-text="Read more" close-text="Read less" style="display: none; width: 600px">
  <span slot="collapse-content">
   <h2>Lorem ipsum dolor</h2>
   <p>
     At vero eos et accusam et justo duo dolores et ea rebum. 
     Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. 
   </p>
  </span>
</collapse-component>

Note:* the slot="collapse-content" attribute must be set otherwise the component will not work.

Properties

close-text

Use the close-text property to specify the text which should appear on the label when the component can be collapsed.

open-text

Use the open-text property to specify the text which should appear on the label when the collapsed component can be expanded.

Planned features

  • Remove jQery as a dependency to increase modularity

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.