Skip to content

Docs website misinformation #2792

@yairEO

Description

@yairEO

Steps to reproduce:

  1. Go to https://nivo.rocks/line/canvas/
  2. Click on 'CUSTOMIZATION' accordion tab in the API

Issues:

  1. The page is for Canvas line but the docs mention the layers should return an SVG element, which is incorrect since it will not be rendered properly in the canvas. (or am I wrong?)
  2. Layers section within CUSTOMIZATION section - missing a the full list of available layers with description what each layer is for. A perfect docs will also include a screenshot which visually shows what each layer controls. Currently the docs only mention the default layers, and it is unclear if there are more layers available that the ones included by default.

For example there is "axes" layer but there is not layer to control individual axe (left/bottom)

Another docs strangeness:

The lineCanvas does not support the enableSlices prop, without any explanation, BUT confusingly the docs does say sliceTooltip prop is supported in Canvas (which makes no sense if canvas has no slices)

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions