Commit Graph

3 Commits

Author SHA1 Message Date
github-actions[bot]
e913e0d5f3 Running lint --fix & prettier (#21515)
Co-authored-by: Dr. Lint-a-lot <garybot2@graylog.com>
2025-02-13 08:15:43 +01:00
Linus Pahl
ae7d57a8e4 Restructure UI documentation and add section about UX patterns. (#13555)
* Update style guide introduction.

* Remove no longer needed section about tests and code style in styleguide beacuse they are now part of the `CONTRIBUTING.md`

* Remove section about util objects, because it does not provide a benefit.

* Move setion about how to document shared components into section about shared components.

* List theme font families and sizes dynamically.

* Add section about line heights

* Adding section about UX patterns.

* Adding section about UX patterns.

* Fixing font family section.

* Fixing typos

* Visualize different font families and sizes.

* Removing `tests.md`.

* Simlify `UX Patterns` section.
2022-10-11 10:55:42 +02:00
Edmundo Alvarez
84843a8ac5 Frontend documentation and components gallery (#4383)
* Add react-styleguidist module

* Add basic react styleguidist configuration

- Include shared components in the gallery
- Add build scripts to build the gallery and serve it

* Add some more content to UI documentation

* Add documentation

* Add stylesheets to component gallery

* Add EntityList documentation

* Add examples to documented common components

* Add some more documentation

* Add styles for typeahead

* Add documentation for PageErrorOverview

* Remove missing id warning in example

* Add documentation for Page component

* Add PageHeader documentation

* Add PaginatedList documentation

* Correct header tags

* Add SearchForm documentation

* Use deprecated annotation

* Let consumers of `Select` customize `displayKey`

React Select uses `labelKey` instead of `displayKey` so pass the right
prop down.

* Add documentation for Select component

* Add SelectableList documentation

* Add SortableList and SortableListItem documentation

* Fix props definition in TableList component

* Fix display of select all Input

This prop was not updated when we migrated to our own Input component.

* Add documentation for TableList component

* Add documentation for Timestamp component

* Add documentation for TimeUnit component

* Add TimeUnitInput documentation

* Fix error while rendering component

We used the wrong import here, `moment` doesn't know about timezones.

* Be more explicit about the prop we support

As we specify the `onChange` prop in the TimezoneSelect prop types, we
should at least use it instead of passing it down as other props that
are not listed.

We should restrict the supported props at some point, protecting
our code from changes in underlying components.

* Add documentation for TimezoneSelect component

* Add documentation for TypeAheadDataFilter component

* Add TypeAheadFieldInput documentation

* Fix some TypeAheadDataFilter documentation

* Add TypeAheadInput documentation

* Add documentation for ReactGridContainer

* Add some basic docs

* Update yarn.lock
2017-12-04 17:37:53 +01:00