1.0.517 • Published 4 days ago

pentonville v1.0.517

Weekly downloads
1
License
MIT
Repository
github
Last release
4 days ago

Pentonville

A React component for capturing tab and managing focus events.

<Pentonville>
  <form>
    <input name='one' />
    <input name='two' />
  </form>
</Pentonville>

Once focus enters Pentonville it cannot leave.

On tab flow and focus

Every <form /> input element has an implicit tab index which enables them to accept focus, and be tabbed between, from one to another, in the order they appear in the document. The value of the implicit tab index is 0.

Some other HTML elements can be made to accept focus with an explicit tab index of the same value.

<p tabindex="0">
  This paragraph can accept focus.
</p>

In React the attribute is in camel case but is otherwise the same.

<p tabIndex='0'>
  This paragraph can accept focus.
</p>

(You didn't need a nearly identical second example, but there it is.)

An element can also be given an explicit negative tab index of -1 (to remove it from the tab flow), or an explicit positive tab index of 1 or more (to change its position in the tab flow).

Positive tab indexes are tabbed to in sequence, from the lowest to the highest value, regardless of their order in the document. After reaching the highest value, flow returns to the elements with a zero index, whether implicit and explicit, such that they are tabbed to in sequence, according to their order in the document.

Introducing Pentonville

Sometimes it is desirable to prevent tab flow and focus from moving beyond the boundary of a set of HTML elements. Pentonville is that boundary: once focus has entered, it won't escape.

Tab flow is maintained by moving focus through the order of each element's tab index, from the first to the last, when tab flow is returned to the first element again.

Focus can be put on any element in the sequence, in which case it will proceed according to the tab index. In other words: focus can be put onto an element with a tab index value of 3 and have the next element in the tab flow be the element with a tab index of 4, then 5 and so on, until the positive tab index values have been exhausted and flow proceeds through each element with a tab index of 0, then onto 1 and 2 and back to 3 again.

Focus cannot be put onto any other element. Pentonville won't permit it. Focus will be maintained on whichever element within Pentonville currently has it.

Demonstrating Pentonville

Example Storybooks are available on GitHub.

Clone the repository, then:

npm install
npm run storybook

And with your preferred browser visit http://localhost:6006.

(The Storybooks are not meant to be visually pleasing: they are examples only of the component's behaviour.)

1.0.517

4 days ago

1.0.516

15 days ago

1.0.514

17 days ago

1.0.515

16 days ago

1.0.513

23 days ago

1.0.512

1 month ago

1.0.511

1 month ago

1.0.510

2 months ago

1.0.509

2 months ago

1.0.508

2 months ago

1.0.507

2 months ago

1.0.506

2 months ago

1.0.505

2 months ago

1.0.504

3 months ago

1.0.503

3 months ago

1.0.502

3 months ago

1.0.501

3 months ago

1.0.500

3 months ago

1.0.499

3 months ago

1.0.498

3 months ago

1.0.497

3 months ago

1.0.496

3 months ago

1.0.495

3 months ago

1.0.494

4 months ago

1.0.493

4 months ago

1.0.492

4 months ago

1.0.491

5 months ago

1.0.490

5 months ago

1.0.484

6 months ago

1.0.483

6 months ago

1.0.486

5 months ago

1.0.485

6 months ago

1.0.480

6 months ago

1.0.482

6 months ago

1.0.481

6 months ago

1.0.488

5 months ago

1.0.487

5 months ago

1.0.489

5 months ago

1.0.477

7 months ago

1.0.476

7 months ago

1.0.479

7 months ago

1.0.478

7 months ago

1.0.473

8 months ago

1.0.472

8 months ago

1.0.475

7 months ago

1.0.474

7 months ago

1.0.471

8 months ago

1.0.470

8 months ago

1.0.440

11 months ago

1.0.442

11 months ago

1.0.441

11 months ago

1.0.448

11 months ago

1.0.447

11 months ago

1.0.449

11 months ago

1.0.444

11 months ago

1.0.443

11 months ago

1.0.446

11 months ago

1.0.445

11 months ago

1.0.431

12 months ago

1.0.437

12 months ago

1.0.436

12 months ago

1.0.439

11 months ago

1.0.438

12 months ago

1.0.433

12 months ago

1.0.432

12 months ago

1.0.435

12 months ago

1.0.434

12 months ago

1.0.462

9 months ago

1.0.461

9 months ago

1.0.464

9 months ago

1.0.463

9 months ago

1.0.460

9 months ago

1.0.469

8 months ago

1.0.466

9 months ago

1.0.465

9 months ago

1.0.468

8 months ago

1.0.467

9 months ago

1.0.451

10 months ago

1.0.450

11 months ago

1.0.453

10 months ago

1.0.452

10 months ago

1.0.459

10 months ago

1.0.458

10 months ago

1.0.455

10 months ago

1.0.454

10 months ago

1.0.457

10 months ago

1.0.456

10 months ago

1.0.420

12 months ago

1.0.426

12 months ago

1.0.425

12 months ago

1.0.428

12 months ago

1.0.427

12 months ago

1.0.422

12 months ago

1.0.421

12 months ago

1.0.424

12 months ago

1.0.423

12 months ago

1.0.419

12 months ago

1.0.418

1 year ago

1.0.415

1 year ago

1.0.414

1 year ago

1.0.417

1 year ago

1.0.416

1 year ago

1.0.411

1 year ago

1.0.413

1 year ago

1.0.412

1 year ago

1.0.407

1 year ago

1.0.430

12 months ago

1.0.429

12 months ago

1.0.404

1 year ago

1.0.403

1 year ago

1.0.406

1 year ago

1.0.405

1 year ago

1.0.400

1 year ago

1.0.402

1 year ago

1.0.401

1 year ago

1.0.396

1 year ago

1.0.395

1 year ago

1.0.398

1 year ago

1.0.397

1 year ago

1.0.394

1 year ago

1.0.393

1 year ago

1.0.399

1 year ago

1.0.327

1 year ago

1.0.326

1 year ago

1.0.329

1 year ago

1.0.328

1 year ago

1.0.323

1 year ago

1.0.325

1 year ago

1.0.324

1 year ago

1.0.385

1 year ago

1.0.384

1 year ago

1.0.387

1 year ago

1.0.386

1 year ago

1.0.381

1 year ago

1.0.380

1 year ago

1.0.383

1 year ago

1.0.382

1 year ago

1.0.389

1 year ago

1.0.388

1 year ago

1.0.374

1 year ago

1.0.373

1 year ago

1.0.376

1 year ago

1.0.375

1 year ago

1.0.370

1 year ago

1.0.372

1 year ago

1.0.371

1 year ago

1.0.378

1 year ago

1.0.377

1 year ago

1.0.379

1 year ago

1.0.392

1 year ago

1.0.391

1 year ago

1.0.390

1 year ago

1.0.341

1 year ago

1.0.340

1 year ago

1.0.343

1 year ago

1.0.342

1 year ago

1.0.349

1 year ago

1.0.348

1 year ago

1.0.345

1 year ago

1.0.344

1 year ago

1.0.347

1 year ago

1.0.346

1 year ago

1.0.330

1 year ago

1.0.332

1 year ago

1.0.331

1 year ago

1.0.338

1 year ago

1.0.337

1 year ago

1.0.339

1 year ago

1.0.334

1 year ago

1.0.333

1 year ago

1.0.336

1 year ago

1.0.335

1 year ago

1.0.363

1 year ago

1.0.362

1 year ago

1.0.365

1 year ago

1.0.364

1 year ago

1.0.361

1 year ago

1.0.360

1 year ago

1.0.367

1 year ago

1.0.366

1 year ago

1.0.369

1 year ago

1.0.368

1 year ago

1.0.352

1 year ago

1.0.351

1 year ago

1.0.354

1 year ago

1.0.353

1 year ago

1.0.350

1 year ago

1.0.359

1 year ago

1.0.356

1 year ago

1.0.355

1 year ago

1.0.358

1 year ago

1.0.357

1 year ago

1.0.305

1 year ago

1.0.304

1 year ago

1.0.307

1 year ago

1.0.306

1 year ago

1.0.301

1 year ago

1.0.300

1 year ago

1.0.303

1 year ago

1.0.302

1 year ago

1.0.321

1 year ago

1.0.320

1 year ago

1.0.322

1 year ago

1.0.319

1 year ago

1.0.310

1 year ago

1.0.316

1 year ago

1.0.315

1 year ago

1.0.318

1 year ago

1.0.317

1 year ago

1.0.312

1 year ago

1.0.311

1 year ago

1.0.314

1 year ago

1.0.313

1 year ago

1.0.309

1 year ago

1.0.308

1 year ago

1.0.297

1 year ago

1.0.296

1 year ago

1.0.299

1 year ago

1.0.298

1 year ago

1.0.293

1 year ago

1.0.292

1 year ago

1.0.295

1 year ago

1.0.294

1 year ago

1.0.291

1 year ago

1.0.290

2 years ago

1.0.286

2 years ago

1.0.285

2 years ago

1.0.288

2 years ago

1.0.287

2 years ago

1.0.282

2 years ago

1.0.281

2 years ago

1.0.284

2 years ago

1.0.283

2 years ago

1.0.289

2 years ago

1.0.280

2 years ago

1.0.275

2 years ago

1.0.274

2 years ago

1.0.277

2 years ago

1.0.276

2 years ago

1.0.273

2 years ago

1.0.272

2 years ago

1.0.279

2 years ago

1.0.278

2 years ago

1.0.264

2 years ago

1.0.263

2 years ago

1.0.266

2 years ago

1.0.265

2 years ago

1.0.260

2 years ago

1.0.262

2 years ago

1.0.261

2 years ago

1.0.268

2 years ago

1.0.267

2 years ago

1.0.269

2 years ago

1.0.253

2 years ago

1.0.252

2 years ago

1.0.255

2 years ago

1.0.254

2 years ago

1.0.251

2 years ago

1.0.250

2 years ago

1.0.257

2 years ago

1.0.256

2 years ago

1.0.259

2 years ago

1.0.258

2 years ago

1.0.271

2 years ago

1.0.270

2 years ago

1.0.242

2 years ago

1.0.241

2 years ago

1.0.244

2 years ago

1.0.243

2 years ago

1.0.240

2 years ago

1.0.249

2 years ago

1.0.246

2 years ago

1.0.245

2 years ago

1.0.248

2 years ago

1.0.247

2 years ago

1.0.239

2 years ago

1.0.238

2 years ago

1.0.237

2 years ago

1.0.200

2 years ago

1.0.206

2 years ago

1.0.205

2 years ago

1.0.208

2 years ago

1.0.207

2 years ago

1.0.202

2 years ago

1.0.201

2 years ago

1.0.204

2 years ago

1.0.203

2 years ago

1.0.189

2 years ago

1.0.198

2 years ago

1.0.197

2 years ago

1.0.199

2 years ago

1.0.194

2 years ago

1.0.193

2 years ago

1.0.196

2 years ago

1.0.195

2 years ago

1.0.190

2 years ago

1.0.192

2 years ago

1.0.191

2 years ago

1.0.220

2 years ago

1.0.222

2 years ago

1.0.221

2 years ago

1.0.228

2 years ago

1.0.227

2 years ago

1.0.229

2 years ago

1.0.224

2 years ago

1.0.223

2 years ago

1.0.226

2 years ago

1.0.225

2 years ago

1.0.211

2 years ago

1.0.210

2 years ago

1.0.217

2 years ago

1.0.216

2 years ago

1.0.219

2 years ago

1.0.218

2 years ago

1.0.213

2 years ago

1.0.212

2 years ago

1.0.215

2 years ago

1.0.214

2 years ago

1.0.209

2 years ago

1.0.231

2 years ago

1.0.230

2 years ago

1.0.233

2 years ago

1.0.232

2 years ago

1.0.235

2 years ago

1.0.234

2 years ago

1.0.236

2 years ago

1.0.187

2 years ago

1.0.186

2 years ago

1.0.188

2 years ago

1.0.183

2 years ago

1.0.182

2 years ago

1.0.185

2 years ago

1.0.184

2 years ago

1.0.149

2 years ago

1.0.148

2 years ago

1.0.165

2 years ago

1.0.164

2 years ago

1.0.167

2 years ago

1.0.166

2 years ago

1.0.161

2 years ago

1.0.160

2 years ago

1.0.163

2 years ago

1.0.162

2 years ago

1.0.169

2 years ago

1.0.168

2 years ago

1.0.154

2 years ago

1.0.153

2 years ago

1.0.156

2 years ago

1.0.155

2 years ago

1.0.150

2 years ago

1.0.152

2 years ago

1.0.151

2 years ago

1.0.158

2 years ago

1.0.157

2 years ago

1.0.159

2 years ago

1.0.181

2 years ago

1.0.180

2 years ago

1.0.176

2 years ago

1.0.175

2 years ago

1.0.178

2 years ago

1.0.177

2 years ago

1.0.172

2 years ago

1.0.171

2 years ago

1.0.174

2 years ago

1.0.173

2 years ago

1.0.179

2 years ago

1.0.170

2 years ago

1.0.143

2 years ago

1.0.145

2 years ago

1.0.144

2 years ago

1.0.147

2 years ago

1.0.146

2 years ago

1.0.142

2 years ago

1.0.141

2 years ago

1.0.140

2 years ago

1.0.132

2 years ago

1.0.131

2 years ago

1.0.134

2 years ago

1.0.133

2 years ago

1.0.130

2 years ago

1.0.139

2 years ago

1.0.136

2 years ago

1.0.135

2 years ago

1.0.138

2 years ago

1.0.137

2 years ago

1.0.77

2 years ago

1.0.76

2 years ago

1.0.75

2 years ago

1.0.74

2 years ago

1.0.79

2 years ago

1.0.78

2 years ago

1.0.101

2 years ago

1.0.100

2 years ago

1.0.107

2 years ago

1.0.106

2 years ago

1.0.109

2 years ago

1.0.108

2 years ago

1.0.103

2 years ago

1.0.102

2 years ago

1.0.105

2 years ago

1.0.104

2 years ago

1.0.121

2 years ago

1.0.120

2 years ago

1.0.123

2 years ago

1.0.122

2 years ago

1.0.129

2 years ago

1.0.128

2 years ago

1.0.125

2 years ago

1.0.124

2 years ago

1.0.127

2 years ago

1.0.126

2 years ago

1.0.80

2 years ago

1.0.84

2 years ago

1.0.83

2 years ago

1.0.82

2 years ago

1.0.81

2 years ago

1.0.88

2 years ago

1.0.87

2 years ago

1.0.86

2 years ago

1.0.85

2 years ago

1.0.89

2 years ago

1.0.110

2 years ago

1.0.112

2 years ago

1.0.111

2 years ago

1.0.118

2 years ago

1.0.117

2 years ago

1.0.119

2 years ago

1.0.114

2 years ago

1.0.113

2 years ago

1.0.116

2 years ago

1.0.115

2 years ago

1.0.91

2 years ago

1.0.90

2 years ago

1.0.95

2 years ago

1.0.94

2 years ago

1.0.93

2 years ago

1.0.92

2 years ago

1.0.99

2 years ago

1.0.98

2 years ago

1.0.96

2 years ago

1.0.62

2 years ago

1.0.61

2 years ago

1.0.60

2 years ago

1.0.66

2 years ago

1.0.65

2 years ago

1.0.64

2 years ago

1.0.63

2 years ago

1.0.69

2 years ago

1.0.68

2 years ago

1.0.67

2 years ago

1.0.73

2 years ago

1.0.72

2 years ago

1.0.71

2 years ago

1.0.70

2 years ago

1.0.55

2 years ago

1.0.54

2 years ago

1.0.53

2 years ago

1.0.52

2 years ago

1.0.59

2 years ago

1.0.58

2 years ago

1.0.57

2 years ago

1.0.56

2 years ago

1.0.44

3 years ago

1.0.43

3 years ago

1.0.42

3 years ago

1.0.41

3 years ago

1.0.48

3 years ago

1.0.47

3 years ago

1.0.46

3 years ago

1.0.45

3 years ago

1.0.49

2 years ago

1.0.51

2 years ago

1.0.50

2 years ago

1.0.39

3 years ago

1.0.40

3 years ago

1.0.38

3 years ago

1.0.33

3 years ago

1.0.37

3 years ago

1.0.36

3 years ago

1.0.35

3 years ago

1.0.34

3 years ago

1.0.26

3 years ago

1.0.25

3 years ago

1.0.24

3 years ago

1.0.23

3 years ago

1.0.29

3 years ago

1.0.28

3 years ago

1.0.27

3 years ago

1.0.32

3 years ago

1.0.31

3 years ago

1.0.30

3 years ago

1.0.19

3 years ago

1.0.22

3 years ago

1.0.21

3 years ago

1.0.20

3 years ago

1.0.18

3 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.13

4 years ago

1.0.12

4 years ago

1.0.11

4 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.4

5 years ago

1.0.3

6 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago