2020-07-20 00:55:03 -04:00
# Banner web part
2021-05-02 15:04:59 -04:00
> NOTE: This sample is available in the [PnP Starter Kit](https://github.com/pnp/sp-starter-kit). You can find the sample code for this web part at https://github.com/pnp/sp-starter-kit/tree/master/solution/src/webparts/banner.
2020-07-20 00:55:03 -04:00
This web part provides you the ability to add a variable height image banner with a linkable title.
## How to use this web part on your web pages
1. Place the page you want to add this web part to in edit mode.
2. Search for and insert the **Banner** web part.
3. Configure the web part to update its properties.
## Configurable Properties
2021-04-26 02:08:59 -04:00
The `Banner` web part can be configured with the following properties:
2020-07-20 00:55:03 -04:00
| Label | Property | Type | Required | Description |
| ---- | ---- | ---- | ---- | ---- |
| Overlay image text | bannerText | string | no | The text message or title you want displayed on the banner image |
| Image URL | bannerImage | string | no | The url of the banner image |
| Link URL | bannerLink | string | no | The hyperlink url of the bannerText link |
| Banner height | bannerHeight | number | no | Provides the fixed height of the banner image |
| Enable parallax effect | useParallax | toggle | no | Enable if you want to include parallax effect on vertical scrolling |
2021-04-26 02:08:59 -04:00
## Installing the web part
2020-07-20 00:55:03 -04:00
2021-05-02 15:04:59 -04:00
See getting started from [SP-Starter-Kit repository readme ](https://github.com/pnp/sp-starter-kit ).
2020-07-20 00:55:03 -04:00
2021-05-02 15:04:59 -04:00
You can also download just the [SharePoint Framework solution package (spppkg) file ](https://github.com/pnp/sp-starter-kit/blob/master/package/sharepoint-starter-kit.sppkg ) and install that to your tenant. This web part does not have external dependencies.
2020-07-20 00:55:03 -04:00
2021-04-26 02:08:59 -04:00
## Screenshots
2020-07-20 00:55:03 -04:00
2021-04-26 02:08:59 -04:00
## Source Code
2020-07-20 00:55:03 -04:00
2021-05-02 15:04:59 -04:00
https://github.com/pnp/sp-starter-kit/tree/master/solution/src/webparts/banner
2020-07-20 00:55:03 -04:00
2021-04-26 02:08:59 -04:00
## Minimal Path to Awesome
2020-07-20 00:55:03 -04:00
- Clone this repository
- Move to Solution folder
- in the command line run:
- `npm install`
- `gulp serve`
2021-04-26 02:08:59 -04:00
## Version history
2020-07-20 00:55:03 -04:00
Version|Date|Comments
-------|----|--------
1.0|May 2018|Initial release
2021-12-20 10:25:30 -05:00
< img src = "https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-banner" / >
