Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework documentation front #46

Merged
merged 148 commits into from
Oct 24, 2024
Merged

Rework documentation front #46

merged 148 commits into from
Oct 24, 2024

Conversation

MGREMY
Copy link
Collaborator

@MGREMY MGREMY commented Jul 4, 2024

Changes :

Component pages

  • Accordion
  • Alert
  • Badge
  • Breadcrumb
  • Button
  • Dropdown
  • Indicator
  • Modal
  • Navbar
  • Scroll-top
  • Sidebar

Each pages

  • List on right side with important part of the page (ex. Alert → Default alert | Alert with icon)

Each files

  • Documentation for JSDoc comment on everything to make generated API documentation complete

Customize pages

  • Override component base style → Add a page to explain how to override component's base style used in theme services
  • CustomStyle → Add a page to explain how to add CustomStyle OR add a section per component pages with dedicated example
  • Inheriting component → Add a page to explain how to create component with inheritance

Fixes and features

  • Change input type boolean from boolean string | boolean to boolean, unknown as the input of booleanAttribute is unknown
  • Move default value in child component to be the one in parent component (ex. SidebarItemComponent.color = (SidebarItemGroupComponent||SidebarMenuComponent).color
  • Update SidebarItemComponent's color to get SidebarItemGroup or SidebarMenuComponent's color
  • Move shared features to structural directive if possible
  • Remove isolate class from demo page processor
  • Sidebar display over with backdrop
  • Modal backdrop, see Modal doesn't close if you go back a page on your website. #33

Future breaking changes

To be defined

Optimization

  • Make all components implement ChangeDetectionStrategy.OnPush detection method

Encapsulation

  • Make all components implement ViewEncapsulation.None

Architecture

* docs(navbar): add navbar example with brand and dropdown

inspired by flowbite-react

* docs(navbar): add example of responsive navbar

* docs(navbar): fix flowbite-navbar-brand placement

* docs(navbar): add description to responsive example

* docs(navbar): auto close if possible
… (#62)

fix(docs): revert `ul` and `ol` only outside of `flowbite-dropdown`
@MGREMY
Copy link
Collaborator Author

MGREMY commented Oct 24, 2024

The remaining items of this PR will be treated on another branch after some project setup adjustment.
The next branch will be focused on versioning setup, project setup (and switch (yes again) from npm to pnpm), version switch (will be setup to use latest 18.0.0 LTS angular version), and other project/repo stuff.

@MGREMY MGREMY merged commit 1c0296a into main Oct 24, 2024
2 of 3 checks passed
@MGREMY MGREMY deleted the rework_documentation_front branch October 24, 2024 13:13
@MGREMY
Copy link
Collaborator Author

MGREMY commented Nov 4, 2024

🎉 This PR is included in version 1.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MGREMY
Copy link
Collaborator Author

MGREMY commented Nov 11, 2024

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request released on @beta released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to match other Flowbite project's documentations Rework form related component
3 participants