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

feat(checkbox): uncontrolled checkbox #2789

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions elements/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"./pf-button/pf-button.js": "./pf-button/pf-button.js",
"./pf-card/BaseCard.js": "./pf-card/BaseCard.js",
"./pf-card/pf-card.js": "./pf-card/pf-card.js",
"./pf-checkbox/pf-checkbox.js": "./pf-checkbox/pf-checkbox.js",
"./pf-chip/pf-chip.js": "./pf-chip/pf-chip.js",
"./pf-chip/pf-chip-group.js": "./pf-chip/pf-chip-group.js",
"./pf-clipboard-copy/BaseClipboardCopy.js": "./pf-clipboard-copy/BaseClipboardCopy.js",
Expand Down
11 changes: 11 additions & 0 deletions elements/pf-checkbox/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Checkbox
Add a description of the component here.

## Usage
Describe how best to use this web component along with best practices.

```html
<pf-checkbox>

</pf-checkbox>
```
3 changes: 3 additions & 0 deletions elements/pf-checkbox/demo/demo.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pf-checkbox {
/* insert demo styles */
}
6 changes: 6 additions & 0 deletions elements/pf-checkbox/demo/pf-checkbox.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<link rel="stylesheet" href="demo.css">
<script type="module">
import '@patternfly/elements/pf-checkbox/pf-checkbox.js';
</script>

<pf-checkbox></pf-checkbox>
17 changes: 17 additions & 0 deletions elements/pf-checkbox/docs/pf-checkbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{% renderOverview %}
<pf-checkbox></pf-checkbox>
{% endrenderOverview %}

{% band header="Usage" %}{% endband %}

{% renderSlots %}{% endrenderSlots %}

{% renderAttributes %}{% endrenderAttributes %}

{% renderMethods %}{% endrenderMethods %}

{% renderEvents %}{% endrenderEvents %}

{% renderCssCustomProperties %}{% endrenderCssCustomProperties %}

{% renderCssParts %}{% endrenderCssParts %}
21 changes: 21 additions & 0 deletions elements/pf-checkbox/pf-checkbox.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.container {
/* padding: 12px 8px; */
margin: 48px;
}

.container .heading {
margin:0 0 12px 0;
font-size: 16px;
font-weight: 600;
color:#514646;
}

.container .pf-c-check {
padding-left: 16px;
}

.container .heading__controlled {
margin-top: 8px;
margin-bottom: 0px;
}

71 changes: 71 additions & 0 deletions elements/pf-checkbox/pf-checkbox.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import { LitElement, html } from 'lit';
import { customElement } from 'lit/decorators/custom-element.js';

import styles from './pf-checkbox.css';

/**
* Checkbox
* @slot - Place element content here
*/
@customElement('pf-checkbox')
export class PfCheckbox extends LitElement {
static readonly styles = [styles];

#getElement() {
const checkbox = document.querySelector('pf-checkbox');
const checkbasic = checkbox!.shadowRoot!.getElementById('check-basic') as HTMLInputElement;
return checkbasic;
}

keydown(event: KeyboardEvent) {
const checkbox = this.#getElement();
if (event.code === 'Enter' || event.code === 'Space') {
event.preventDefault();
checkbox.checked = !checkbox.checked;
// Optionally, you can also update aria-checked attribute for screen readers
checkbox.setAttribute('aria-checked', checkbox.checked ? 'true' : 'false');
}
}

click() {
const checkbox = this.#getElement();
checkbox.setAttribute('aria-checked', checkbox.checked ? 'true' : 'false');
}

render() {
return html`
<slot>
<div class="container">
<h1 class="heading">Uncontrolled </h1>
<div class="pf-c-check">
<input
class="pf-c-check__input"
type="checkbox"
id="check-basic"
name="check-basic"
@keydown=${this.keydown}
@click=${this.click}

/>
<label class="pf-c-check__label" for="check-basic">Uncontrolled CheckBox </label>
</div>
</div>
</slot>
`;
}
}


declare global {
interface HTMLElementTagNameMap {
'pf-checkbox': PfCheckbox;
}
}

//

// checkbox.addEventListener('click', function(event) {
// // Update aria-checked attribute for screen readers
// checkbox.setAttribute('aria-checked', checkbox.checked ? 'true' : 'false');
// });

12 changes: 12 additions & 0 deletions elements/pf-checkbox/test/pf-checkbox.e2e.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { test } from '@playwright/test';
import { PfeDemoPage } from '@patternfly/pfe-tools/test/playwright/PfeDemoPage.js';

const tagName = 'pf-checkbox';

test.describe(tagName, () => {
test('snapshot', async ({ page }) => {
const componentPage = new PfeDemoPage(page, tagName);
await componentPage.navigate();
await componentPage.snapshot();
});
});
21 changes: 21 additions & 0 deletions elements/pf-checkbox/test/pf-checkbox.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { expect, html } from '@open-wc/testing';
import { createFixture } from '@patternfly/pfe-tools/test/create-fixture.js';
import { PfCheckbox } from '@patternfly/elements/pf-checkbox/pf-checkbox.js';

describe('<pf-checkbox>', function() {
describe('simply instantiating', function() {
let element: PfCheckbox;
it('imperatively instantiates', function() {
expect(document.createElement('pf-checkbox')).to.be.an.instanceof(PfCheckbox);
});

it('should upgrade', async function() {
element = await createFixture<PfCheckbox>(html`<pf-checkbox></pf-checkbox>`);
const klass = customElements.get('pf-checkbox');
expect(element)
.to.be.an.instanceOf(klass)
.and
.to.be.an.instanceOf(PfCheckbox);
});
});
});
Loading