Skip to content

docs: add comprehensive installation and usage docs to all package READMEs#1489

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-package-readme-files
Draft

docs: add comprehensive installation and usage docs to all package READMEs#1489
Copilot wants to merge 2 commits intomainfrom
copilot/update-package-readme-files

Conversation

Copy link
Contributor

Copilot AI commented Mar 9, 2026

Each package README contained only a single sentence pointing to the website. The root README lacked per-package detail. This PR expands all four to be self-contained references.

Root README.md

  • Replaces flat "Installation" section with a Packages section
  • Each package gets its own description, install snippet, usage example, and a list of available effects/components/elements
  • Fixes a typo: <bx-slider-controls><bs-slider-controls> (with correct closing tag)

packages/slider/README.md

  • Installation via NPM and CDN
  • Usage with HTML structure + factory function call
  • BoxSliderOptions reference table (all 8 options)
  • All four effects (createCarouselSlider, createCubeSlider, createFadeSlider, createTileSlider) with their effect-specific options
  • Event listener examples and BoxSlider instance API (next, prev, skipTo, play, pause, reset, destroy, activeIndex, length, getOption)

packages/react/README.md

  • React 19+ requirement + installation
  • All five components with props tables: CarouselSlider, CubeSlider, FadeSlider, TileSlider, SliderControls
  • Common slider props table shared across all components
  • Event handler props (onBefore, onAfter, onPlay, onPause, …) with sliderRef usage example

packages/components/README.md

  • Installation via NPM and CDN
  • All five custom elements with attribute tables: <bs-carousel>, <bs-cube>, <bs-fade>, <bs-tile>, <bs-slider-controls>
  • unstyled attribute for opting out of built-in control styles
  • Common attributes table and custom events reference
<!-- components example -->
<bs-slider-controls>
  <bs-carousel timing-function="ease-in-out">
    <div>Slide one</div>
    <div>Slide two</div>
  </bs-carousel>
</bs-slider-controls>
// React example with event handlers and ref access
const sliderRef = useRef<BoxSlider>(null)

<CarouselSlider
  sliderRef={sliderRef}
  onBefore={({ currentIndex, nextIndex }) => }
  onAfter={({ currentIndex }) => }
>
  
</CarouselSlider>
Original prompt

Update package readme files with a more comprehensive description of how to install and use the library and components. Also update the root readme with more details about the individual packages


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@changeset-bot
Copy link

changeset-bot bot commented Mar 9, 2026

⚠️ No Changeset found

Latest commit: a4b5f1e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI changed the title [WIP] Update package readme files for installation and usage details docs: add comprehensive installation and usage docs to all package READMEs Mar 9, 2026
Copilot finished work on behalf of p-m-p March 9, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants