loading...
Cover image for Show and Hide Content Easily With details and summary HTML Tags

Show and Hide Content Easily With details and summary HTML Tags

vtrpldn profile image Vitor Paladini Updated on ใƒป2 min read

Here's a neat little trick:

You can use the <details> and <summary> HTML tags to create a simple accordion/collapsible UI.

Summary/Details tags example

The only problem here is that it looks rather plain and uninteresting.

But nothing that a few lines of CSS can't fix! Here's how it looks with just a little bit of styling.

Remember that you can click the "Open Sandbox" button and edit the styles yourself. I'm sure that you can make it look even nicer. ๐Ÿ˜„

Oh, and here's the CSS, take a look. It features a couple hacks with padding and box-shadow to make the "border" look consistent but, other than that, it is a pretty simple change.

/* The --padding variable help us control 
the <details> and <summary> spacing */
:root {
  --padding: 16px;
}

details {
  padding: 0 var(--padding);
  box-shadow: inset 0 0 0 4px;
  border-radius: 4px;
}
details[open] {
  padding-bottom: var(--padding);
}

details > summary {
  display: flex;
  padding: var(--padding);
  margin: 0 calc(var(--padding) * -1);
  border-radius: 4px;
  font-size: 24px;
  cursor: pointer;
  justify-content: space-between;
  list-style: none; /* Hides the default arrow */
}
details[open] > summary {
  box-shadow: 0 4px;
}
/* Adds an icon when the <details> is closed... */
details > summary::after {
  content: "+";
}
/* ...and switches it when <details> is open */
details[open] > summary::after {
  content: "-";
}
/* Removes the ugly default arrow on Chrome */
details > summary::-webkit-details-marker {
  display: none;
}

I love how much you can accomplish with plain HTML and CSS.

And by using standard HTML tags you get great accessibility for free!

But wait, there's more!

You can go even further and transform these two tags into a powerful and, dare I say, extremely reusable component.

Let's add some React to it! โš›๏ธ

These two tags work very well with React's component composition pattern.

So you can just go ahead and create a component to help you toggle stuff more consistently and easier.

Look:

Then you can import that component and use it like so:

This is a great component to have on your toolbelt for when you need to implement a few accordions quickly.

Thanks for checking out this neat little trick ๐Ÿ‘‹

I hope it comes in handy soon!

Do you have a suggestion for a neat little trick? Leave it on the comments or mention me on Twitter.

Oh! And remember to check the other articles on this series below. They are some spicy little nuggets of webdev knowledge.

Cover photo by Dominik Vanyi on Unsplash

Posted on by:

vtrpldn profile

Vitor Paladini

@vtrpldn

A software engineer that really likes working with user interfaces. Writes mostly JS at a small (but mighty!) Danish startup. Loves cooking.

Discussion

pic
Editor guide
 

This is a nice and simple trick which I wanted to further investigate myself too at some point. Mostly, I wanted to investigate 2 basic topics:

  • Is it semantically correct to use it as an FAQ or should the markup be different on such cases?
  • Can you apply CSS animations?

Do you happen to have any good resources on the above?

 

Hey Giorgos, great questions.

Is it semantically correct to use it as an FAQ or should the markup be different on such cases?

I'd say so, yeah! The says W3C spec says that "The rest of the elementโ€™s contents represents the additional information or controls."

A FAQ answer seems like additional information in my book.

Can you apply CSS animations?

Hmm... To a degree, but animating display and height is particularly tricky. I've found some examples but none particularly good. I'll give it a try and update the article if I find a way to do it ๐Ÿ™‚

 

Hey @vtrpldn , nice post! Great to know about summary/details, love dynamic HTML elements.

btw is it possible (semantically?) to have the component to display in an "open" state by default? Would be cool! :)

 

Hey, Cezar. Thanks!

Yes, you can add an open attribute to it, like so: <details open> and the details box will start in an opened state

 

cool, thanks! been learning nice stuff from your posts here on DEV, keep them coming!

 

Very nice. I'm curious to know how do you make the action clickable without any JS

 

That's just how <details> + <summary> works. It is quite like how you can make a range slider with <input type="range"> ๐Ÿ™‚

 

ahh ok nice! thanks man!

 

Your brain is beautiful, sir!

 

Thanks for your support, Chris

You also have a magnificent cranial anatomy ๐Ÿง 

 

This is neat! Thanks for sharing. Loving your little tricks series, very helpful

 

Thanks, Felipe! I love finding and sharing these little nuggets of webdev, let me know if you have a suggestion ๐Ÿ˜„

 

what a tutorial !
simple, but elegant trick..
thank you!

 

Glad I could help ๐Ÿ˜„