Add enhanced configurations
This commit is contained in:
AriGunawan
parent
d371687c55
commit
5c0ea58a7f
|
|
@ -1,73 +1,111 @@
|
|||
# react-enhanced-button
|
||||
# Enhanced Button
|
||||
|
||||
## Summary
|
||||
|
||||
Short summary on functionality and used technologies.
|
||||
The Enhanced Button Web Part is a custom SharePoint web part that extends the functionality of the native button web part. It provides additional configuration options to create more customizable and flexible buttons within your SharePoint pages.
|
||||
|
||||
[picture of the solution in action, if possible]
|
||||
|
||||
|
||||
## Used SharePoint Framework Version
|
||||
## Compatibility
|
||||
|
||||
|
||||
| :warning: Important |
|
||||
|:---------------------------|
|
||||
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|
||||
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
||||
|
||||
This sample is optimally compatible with the following environment configuration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
- [SharePoint Framework](https://aka.ms/spfx)
|
||||
- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
||||
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](https://aka.ms/m365/devprogram)
|
||||
|
||||
## Prerequisites
|
||||
## Contributors
|
||||
<!--
|
||||
We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it.
|
||||
|
||||
> Any special pre-requisites?
|
||||
We'll only use the info you provided here. Make sure to include your full name, not just your GitHub username.
|
||||
|
||||
## Solution
|
||||
Provide a link to your GitHub profile to help others find more cool things you have done. The only link we'll accept is a link to your GitHub profile.
|
||||
|
||||
| Solution | Author(s) |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| folder name | Author details (name, company, twitter alias with link) |
|
||||
If you want to provide links to your social media, blog, and employer name, make sure to update your GitHub profile.
|
||||
-->
|
||||
|
||||
* [Ari Gunawan](https://github.com/AriGunawan)
|
||||
|
||||
## Version history
|
||||
|
||||
| Version | Date | Comments |
|
||||
| ------- | ---------------- | --------------- |
|
||||
| 1.1 | March 10, 2021 | Update comment |
|
||||
| 1.0 | January 29, 2021 | Initial release |
|
||||
Version|Date|Comments
|
||||
-------|----|--------
|
||||
1.0|September 01, 2024|Initial release
|
||||
|
||||
## Disclaimer
|
||||
## Minimal path to awesome
|
||||
|
||||
**THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-enhanced-button) then unzip it)
|
||||
* From your command line, change your current directory to the directory containing this sample (`react-enhanced-button`, located under `samples`)
|
||||
* in the command line run:
|
||||
* `npm install`
|
||||
* `gulp serve` or `npm run serve`
|
||||
|
||||
---
|
||||
|
||||
## Minimal Path to Awesome
|
||||
|
||||
- Clone this repository
|
||||
- Ensure that you are at the solution folder
|
||||
- in the command-line run:
|
||||
- **npm install**
|
||||
- **gulp serve**
|
||||
|
||||
> Include any additional steps as needed.
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
|
||||
|
||||
## Features
|
||||
|
||||
Description of the extension that expands upon high-level summary above.
|
||||
This web part offers the following enhanced configuration options:
|
||||
|
||||
This extension illustrates the following concepts:
|
||||
Basic configuration options:
|
||||
- **Label**: Customize the button text
|
||||
- **Link**: Specify the URL to link to
|
||||
- **Link Behaviour**: Configure how the button link opens (e.g., same tab, new tab)
|
||||
- **Button Alignment**: Align the button horizontally (left, center, right)
|
||||
- **Width**: Customize the button width
|
||||
- **Height**: Adjust the button height
|
||||
- **Border Radius**: Set the corner roundness of the button
|
||||
|
||||
- topic 1
|
||||
- topic 2
|
||||
- topic 3
|
||||
Advanced configuration options:
|
||||
- **Container Styles**: Apply custom styles to the button container using raw CSS value
|
||||
- **Button Styles**: Customize the button's appearance using raw CSS value
|
||||
- **Button Hover Styles**: Define styles for when users hover over the button using raw CSS value
|
||||
|
||||
> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance.
|
||||
<!--
|
||||
RESERVED FOR REPO MAINTAINERS
|
||||
|
||||
> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp.
|
||||
We'll add the video from the community call recording here
|
||||
|
||||
## References
|
||||
## Video
|
||||
|
||||
- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
|
||||
- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
|
||||
- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
|
||||
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
|
||||
[](https://www.youtube.com/watch?v=XXXXX "YouTube video title")
|
||||
-->
|
||||
|
||||
## Help
|
||||
|
||||
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
||||
|
||||
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
||||
|
||||
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-enhanced-button%22) to see if anybody else is having the same issues.
|
||||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-enhanced-button) and see what the community is saying.
|
||||
|
||||
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-enhanced-button&template=bug-report.yml&sample=react-enhanced-button&authors=@AriGunawan&title=react-enhanced-button%20-%20).
|
||||
|
||||
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-enhanced-button&template=question.yml&sample=react-enhanced-button&authors=@AriGunawan&title=react-enhanced-button%20-%20).
|
||||
|
||||
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-enhanced-button&template=suggestion.yml&sample=react-enhanced-button&authors=@AriGunawan&title=react-enhanced-button%20-%20).
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-enhanced-button" />
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 277 KiB |
|
|
@ -14,6 +14,11 @@ export interface IEnhancedButtonWebPartProps {
|
|||
label: string;
|
||||
link: string;
|
||||
buttonAlignment: string;
|
||||
width: string;
|
||||
height: string;
|
||||
borderRadius: string;
|
||||
linkBehaviour: string;
|
||||
|
||||
containerStyles: string;
|
||||
buttonStyles: string;
|
||||
buttonOnHoverStyles: string;
|
||||
|
|
@ -51,6 +56,13 @@ export default class EnhancedButtonWebPart extends BaseClientSideWebPart<IEnhanc
|
|||
PropertyPaneTextField("link", {
|
||||
label: "Link",
|
||||
}),
|
||||
PropertyPaneDropdown("linkBehaviour", {
|
||||
label: "Link Behaviour",
|
||||
options: [
|
||||
{ key: "_blank", text: "Open in New Tab" },
|
||||
{ key: "_self", text: "Open in Same Tab" },
|
||||
],
|
||||
}),
|
||||
PropertyPaneDropdown("buttonAlignment", {
|
||||
label: "Button Alignment",
|
||||
options: [
|
||||
|
|
@ -59,6 +71,21 @@ export default class EnhancedButtonWebPart extends BaseClientSideWebPart<IEnhanc
|
|||
{ key: "flex-end", text: "Right" },
|
||||
],
|
||||
}),
|
||||
PropertyPaneTextField("width", {
|
||||
label: "Width",
|
||||
}),
|
||||
PropertyPaneTextField("height", {
|
||||
label: "Height",
|
||||
}),
|
||||
PropertyPaneDropdown("borderRadius", {
|
||||
label: "Border Radius",
|
||||
options: [
|
||||
{ key: "0", text: "None" },
|
||||
{ key: "4px", text: "Small" },
|
||||
{ key: "9999px", text: "Medium" },
|
||||
{ key: "100%", text: "Full" },
|
||||
],
|
||||
}),
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -4,11 +4,13 @@
|
|||
}
|
||||
|
||||
.link {
|
||||
width: var(--width);
|
||||
height: var(--height);
|
||||
border-radius: var(--border-radius);
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
text-decoration: none;
|
||||
padding: 8px 16px;
|
||||
border-radius: 4px;
|
||||
background-color: "[theme:themePrimary, default:#0078d7]";
|
||||
color: "[theme:white, default:#ffffff]";
|
||||
cursor: pointer;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
import { css } from "@fluentui/react";
|
||||
import { useId } from "@fluentui/react-hooks";
|
||||
import * as React from "react";
|
||||
import { IEnhancedButtonWebPartProps } from "../EnhancedButtonWebPart";
|
||||
import styles from "./EnhancedButton.module.scss";
|
||||
|
|
@ -6,27 +7,37 @@ import styles from "./EnhancedButton.module.scss";
|
|||
export default function EnhancedButton(
|
||||
props: IEnhancedButtonWebPartProps
|
||||
): React.ReactElement {
|
||||
const id = useId();
|
||||
|
||||
return (
|
||||
<>
|
||||
<style>
|
||||
{`
|
||||
.${styles.enhancedButton} {
|
||||
#${id}.${styles.enhancedButton} {
|
||||
--justify-content: ${props.buttonAlignment};
|
||||
--width: ${props.width || "auto"};
|
||||
--height: ${props.height || "auto"};
|
||||
--border-radius: ${props.borderRadius || "4px"};
|
||||
}
|
||||
.${styles.enhancedButton}.customCss {
|
||||
#${id}.${styles.enhancedButton}.customCss {
|
||||
${props.containerStyles}
|
||||
}
|
||||
.customCss .${styles.link} {
|
||||
#${id}.customCss .${styles.link} {
|
||||
${props.buttonStyles}
|
||||
}
|
||||
|
||||
.customCss .${styles.link}:hover {
|
||||
#${id}.customCss .${styles.link}:hover {
|
||||
${props.buttonOnHoverStyles}
|
||||
}
|
||||
`}
|
||||
</style>
|
||||
<div className={css(styles.enhancedButton, "customCss")}>
|
||||
<a href={props.link} className={styles.link}>
|
||||
<div id={id} className={css(styles.enhancedButton, "customCss")}>
|
||||
<a
|
||||
rel="noopener noreferrer"
|
||||
href={props.link}
|
||||
className={styles.link}
|
||||
target={props.linkBehaviour}
|
||||
>
|
||||
{props.label}
|
||||
</a>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue