diff --git a/.gitignore b/.gitignore index df7a634..9be07b4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ node_modules dist -**/*-debug.log \ No newline at end of file +**/*-debug.log +.solid \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index d3bb2d2..cd99b1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,55 @@ -## Unreleased +## 2025-02-24 - (1.0.21) + +- [Fix: Offcanvas component doesn't unmount when dismissed. #45](https://github.com/solid-libs/solid-bootstrap/issues/45) + +## 2024-05-11 - (1.0.20) + +- [Fix: Toasts don't fire the onClose #43](https://github.com/solid-libs/solid-bootstrap/issues/43) + +## 2023-10-24 - (1.0.19) + +- [Fix: Modals don't support SSR #39](https://github.com/solid-libs/solid-bootstrap/issues/39) + +## 2023-10-11 - (1.0.18) + +- [Fix: Overlay/Popup hangs Chrome browser tab #37 (take 2)](https://github.com/solid-libs/solid-bootstrap/issues/37) + + > Note this required a breaking change for the Core Overlay component. Intead of taking a render prop for children, children is now a normal JSX.Element and the overlay properties are made available via OverlayContext. I don't expect many people were using this component directly, but if you were, you'll need to update your code. + +## 2023-10-11 - (1.0.17) + +- [Fix: Overlay/Popup hangs Chrome browser tab #37](https://github.com/solid-libs/solid-bootstrap/issues/37) + +## 2023-10-10 - (1.0.16) + +- [Fix: Overlay/Popover content is not reactive #36](https://github.com/solid-libs/solid-bootstrap/issues/36) + +## 2023-10-02 - (1.0.15) + +- [Fix: toast messages can't be changed #35](https://github.com/solid-libs/solid-bootstrap/issues/35) + +## 2023-07-11 - (1.0.14) + +- [Fix: Special pagination buttons not reactive #33](https://github.com/solid-libs/solid-bootstrap/issues/33) + +## 2022-12-22 - (1.0.13) + +- [Fix: Modal content is not reactive #26](https://github.com/solid-libs/solid-bootstrap/issues/26) +- [Fix: Modal header close button #27](https://github.com/solid-libs/solid-bootstrap/issues/27) + +## 2022-12-04 - (1.0.10) + +- [Fix: No-op transitions, as needed in Accordion `alwaysOpen` #19](https://github.com/solid-libs/solid-bootstrap/commit/e606ab2e5f067ed9f79e95d59359368d327af5c6) +- Fix various hydration issues when [used with Solid Start](https://start.solidjs.com/getting-started/what-is-solidstart). + +There are no known issues remaining when using Solid Start when using `pnpm`. There is one [outstanding issue](https://github.com/solid-libs/solid-bootstrap/issues/25) related to using npm and the Solid Start templates. + +## 2022-04-28 - (1.0.8) - [Feat: Support `class` attribute in addition to `className` attribute (for adding classes to components) #17](https://github.com/solid-libs/solid-bootstrap/commit/7d4055ce0bd09cc9794aa743a90a4c3d025c9639) - [Fix: Make `x-placement` attribute reactive #16](https://github.com/solid-libs/solid-bootstrap/commit/5e10673a430fda8bfb11274b210e3d822d51d022) - [Fix: `x-placement` attribute inherits from `Overlay`](https://github.com/solid-libs/solid-bootstrap/commit/63f3a3e8853e8fe7aabee7e1e7592d4e7303e217) - [Feat: All submodules now have named exports in addition to default exports](https://github.com/solid-libs/solid-bootstrap/commit/11518f5a9b6ac927e2fcc091ea11d77be82b7f75) -- [Fix: Portal position fixed](https://github.com/solid-libs/solid-bootstrap/commit/7428cd7f1cfebb30c6501c518af8ea46f7a5514a) - [Fix: React to children changes without constructing multiple times](https://github.com/solid-libs/solid-bootstrap/commit/e81432380d131859f28471f5447955a4b6c2d142) - Various code cleanup diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8d10be0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +## Repository Layout + +This repository uses [NPM workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces) +to make it easier to manipulate its three NPM packages +(in [`packages`](packages)). + +### How To Build Packages + +After you clone the repository, you can build all three packages like so: + +```sh +npm install +npm run build +``` + +In particular, `npm run build` runs `npm run build` within each package. + +### How To Build The Website + +In the `www` directory, you can start a development server like so: + +```sh +npm run dev +``` + +Note that the development server relies on the built packages, so you need to +`npm run build` in the root directory whenever you change something. + +To build a deployable site in the `dist` subdirectory, +run the following in the `www` directory: + +```sh +npm run build:docs +``` + +To build a deployable site and deploy it to GitHub Pages, +run the following in the `www` directory: + +```sh +npm run gh-pages +``` + +Again, be sure to `npm run build` in the root directory first. diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index defffa0..0000000 --- a/docs/404.html +++ /dev/null @@ -1,13 +0,0 @@ - - -
- -import { Accordion } from 'solid-bootstrap'| Name | Type | Default | Description |
|---|---|---|---|
| activeKey | string | string[] | The current active key that corresponds to the currently expanded card | |
| alwaysOpen | boolean | Allow accordion items to stay open when another item is opened | |
| as | elementType | Set a custom element for this component | |
| defaultActiveKey | string | string[] | The default active key that is expanded on start | |
| flush | boolean | Renders accordion edge-to-edge with its parent container | |
| bsPrefix | string | 'accordion' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <div> | Set a custom element for this component |
| eventKey required | string | A unique key used to control this item's collapse/expand. | |
| bsPrefix | string | 'accordion-item' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <h2> | Set a custom element for this component |
| onClick | function | Click handler for the | |
| bsPrefix | string | 'accordion-header' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <div> | Set a custom element for this component |
| bsPrefix | string | 'accordion-body' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <button> | Set a custom element for this component |
| onClick | function | A callback function for when this component is clicked | |
| bsPrefix | string | 'accordion-button' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <div> | Set a custom element for this component |
| children required | element | Children prop should only contain a single child, and is enforced as such | |
| eventKey required | string | A key that corresponds to the toggler that triggers this collapse's expand or collapse. |
import { Alert } from 'solid-bootstrap'| Name | Type | Default | Description |
|---|---|---|---|
| closeLabel | string | 'Close alert' | Sets the text for alert close button. |
| closeVariant | 'white' | Sets the variant for close button. | |
| dismissible | boolean | Renders a properly aligned dismiss button, as well as adding extra horizontal padding to the Alert. | |
| onClose | function | controls showCallback fired when alert is closed. | |
| show | boolean | true | controlled by: onClose, initial prop: defaultShowControls the visual state of the Alert. |
| transition | boolean | elementType | Fade | Animate the alert dismissal. Defaults to using |
| variant | 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'primary' | The Alert visual variant |
| bsPrefix | string | 'alert' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <DivStyledAsH4> | You can use a custom element type for this component. |
| bsPrefix required | string | 'alert-heading' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <Anchor> | You can use a custom element type for this component. |
| bsPrefix required | string | 'alert-link' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.
"),A=i("import { Badge } from 'solid-bootstrap'| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <span> | You can use a custom element type for this component. |
| bg | 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark' | 'primary' | The visual style of the badge |
| pill | boolean | false | Add the |
| text | 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark' | Sets badge text color | |
| bsPrefix | string | 'badge' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
import { Breadcrumb } from 'solid-bootstrap'| Name | Type | Default | Description |
|---|---|---|---|
| as | elementType | <nav> | You can use a custom element type for this component. |
| label | string | 'breadcrumb' | ARIA label for the nav element https://www.w3.org/TR/wai-aria-practices/#breadcrumb |
| listProps | object | | Additional props passed as-is to the underlying |
| bsPrefix | string | 'breadcrumb' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| active | boolean | false | Adds a visual "active" state to a Breadcrumb Item and disables the link. |
| as | elementType | <li> | You can use a custom element type for this component. |
| href | string |
| |
| linkAs | elementType | <Anchor> | You can use a custom element type for this component's inner link. |
| linkProps | object | | Additional props passed as-is to the underlying link for non-active items. |
| target | string |
| |
| title | node |
| |
| bsPrefix | string | 'breadcrumb-item' | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| active | boolean | Manually set the visual state of the button to | |
| as | elementType | You can use a custom element type for this component. | |
| disabled | boolean | Disables the Button, preventing mouse events, even if the underlying component is an element | |
| href | string | Providing a will render an element, styled as a button. | |
| size | | | Specifies a large or small button. | |
| type | | | | | Defines HTML button type attribute. | |
| variant | string | One or more button variant combinations buttons may be one of a variety of visual variants such as: as well as "outline" versions (prefixed by 'outline-*') | |
| bsPrefix | string | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | An HTML name for each child button. Required if is set to | |
| onChange | function | controls Callback fired when a button is pressed, depending on whether the is or , will be called with the value or array of active values | |
| size | | | Sets the size for all Buttons in the group. | |
| type | | | The input of the rendered buttons, determines the toggle behavior of the buttons | |
| value | any | controlled by: , initial prop: The value, or array of values, of the active (pressed) buttons | |
| vertical | boolean | Make the set of Buttons appear vertically stacked. |
| Name | Type | Default | Description |
|---|---|---|---|
| checked | boolean | The checked state of the input, managed by automatically | |
| disabled | boolean | The disabled state of both the label and input | |
| idrequired | string | is required for button clicks to toggle input. | |
| inputRef | A ref attached to the element | ||
| name | string | The HTML input name, used to group like checkboxes or radio buttons together semantically | |
| onChange | function | A callback fired when the underlying input element changes. This is passed directly to the so shares the same signature as a native event. | |
| type | | | The element | |
| valuerequired | string|arrayOf|number | The value of the input, should be unique amongst it's siblings when nested in a . | |
| bsPrefix | string | Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css. |