DataTable: Stop using <div> inside <thead>

Question for Carbon

The DataTable’s header has a <div> inside a <th>, which is apparently invalid HTML. It can be seen on https://react.carbondesignsystem.com/?path=/story/components-datatable-basic--default.

<thead>
   <tr>
      <th scope="col">
         <div class="cds--table-header-label">Name</div>
     </th>
...

Can/should it be changed to a <span>?

It gives us spurious console errors and errors running our unit tests (which is bad because it masks any real errors that might occur):

    Warning: validateDOMNesting(...): <div> cannot appear as a child of <thead>.
        in div (created by DatagridHead)
        in thead (created by TableHead)
        in TableHead (created by DatagridHead)
        in DatagridHead (created by Datagrid)
        in table (created by Table)
        in div (created by Table)
        in Table (created by Datagrid)

Note: it’s the same problem in both Carbon 10 and Carbon 11.

Code of Conduct

• I agree to follow this project’s Code of Conduct

[tay1orjones]

validateDOMNesting expects children of thead to be one of tr, style, script, or template per the html spec (source)

[wkeese]

Whoops, you’re right, I was misinterpreting the error message. So it’s DatagridHead’s fault, which is adding a <div> as a direct child of the <thead>. The code comment says “block element needed for sticky header and scrolling of body”, although I’m not sure if that’s really true. In any case, not carbon’s fault.